tiny+ knowledge base
Search…
⌃K

Companies

get
https://api.tiny.plus
/v2/companies/{{id}}
Get a Company

Example Usage

jQuery
PHP
var settings = {
"url": "https://api.tiny.plus/v2/companies/{{id}}",
"method": "GET",
"headers": {
"Authorization": "{{user_access_token}}"
}
};
​
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.tiny.plus/v2/companies/{{id}}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: {{user_access_token}}"
),
));
​
$response = curl_exec($curl);
$err = curl_error($curl);
​
curl_close($curl);
​
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
} ?>
get
https://api.tiny.plus
/v2/companies
List Companies

Example Usage

jQuery
PHP
var settings = {
"url": "https://api.tiny.plus/v2/companies?me&return_format=array",
"method": "GET",
"headers": {
"Authorization": "{{user_access_token}}"
}
};
​
$.ajax(settings).done(function (response) {
console.log(response);
});
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.tiny.plus/v2/companies?me&return_format=array",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: {{user_access_token}}"
),
));
​
$response = curl_exec($curl);
$err = curl_error($curl);
​
curl_close($curl);
​
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
} ?>
post
https://api.tiny.plus
/v2/companies
Create a Company
patch
https://api.tiny.plus
/v2/companies/{{id}}
Update a Company
delete
https://api.tiny.plus
/v2/companies/{{id}}
Delete a Company

Companies Field Reference

Field
Type
Details
Permission
id
Number
Unique record identifier.
Read-only
name
String (up to 200 characters).
REQUIRED.
Company Name.
Full
description
String
Description.
Full
created_date
String (YYYY-MM-DD hh:mm:ss)
Date record was first created.
Read-only
modified_date
String (YYYY-MM-DD hh:mm:ss)
Date record was last modified.
Read-only
created_user
Number
ID of user who made the record.
Read-only
modified_user
Number
ID of user who last edited the record.
Read-only
assigned_user
Number
ID of assigned user.
Full
is_synced
Boolean
Whether the record has been synced from another source.
Full
sync_origin
String (up to 50 characters)
A simple string that you supply to let tiny+ users know where the record is synced from.
Full
remote_id
String (up to 200 characters)
A remote identifier for this record.
Full
record_status
String
The relationship status of the Company. Note that this status field is intended for client companies, so non-client companies should not recieve a relationship status. Values you can use: prospect, active, latent, "" - ie blank.
When adding or editing a company, if your account is using additional phases for company relationship status, you must pass the correct phase ID here in place of the possible values.
Full
record_url
String
The fully qualified URI of the record.
Read-only
external_url
String or JSON object
A link to this company in another system. Helpful when used with sync_origin. This can hold a simple string URL. However some records may exist in multiple systems, so we recommend you namespace your external URL by providing a JSON object like so:
{ "MyApp": "https://app.example.com/135" }
This will make sure that other integrations will not interfere with your URL.
Full
Previous
Projects
Next
Contacts
Last modified 2yr ago