This endpoint allows you to get a full Company record.
Path Parameters
Query Parameters
Headers
{"id": 1237"name": "Auchenflower Aged Care","record_status": "prospect","description": "A large aged care provider based in Queensland, Australia.","assigned_user": 1231,...}
{"message": "Company not found."}
Example Usage
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);});
You can create a new tiny+ company with this endpoint. The only required field to create a Company in tiny+ is name, however we recommend you provide as much information as possible.
Headers
Request Body
{
id: [your new ID]
}
{
error: 'Error adding the record.'
}
Update a Company
PATCHhttps://api.tiny.plus/v2/companies/{{id}}
You can edit a tiny+ Company with this endpoint. Note: you only need to pass the field you wish to change.
Can be either 1 or 0. Default is 1. When passed, information about the related records to the requested record are also returned, in a 'related' object.
If you don't need the related records, set this to 0 for a performance improvement.
Authorization
string
Your access token.
{{field_name}}
string
You can provide any {{field_name}} listed in the Fields Reference as a filter to the projects returned.
You can also provide a minimum or maximum value by prepending a < or > before your value, which is useful for returning records modified or created after a certain datetime stamp.
To return all projects for user 1232:
/projects/?assigned_user=1232To return all projects modified after a date:/projects/?modified_date=>2019-01-01 14:00:00To return all Active projects:/projects/?record_status=active
with_health
boolean
If this key is present, we will return a health key for each returned record, which is a score between 0 and 100 identifying the relative health of that Company record.
me
boolean
If this key is present, it will limit the results to only records where the user associated with the API key is the assigned_user or is in the Project Team.
subscribed
boolean
Similar to the me parameter, this parameter when present returns all records for the user associated with the API key is the assigned_user, or is in the Project Team, or is a subscriber to the record.
limit
number
Used for pagination. Limit is the number of records to return from the full resultset. The default is 15.
start
number
Used for pagination. Set this value to the cursor position into the total resultset to return this time. eg. to receive the 101st to the 115th record, set this to 100 and the limit parameter to 15. Default is 0.
sort
string
Provide a field name and optionally a direction separated by a space to sort the returned results. For example, modified_date desc to return the most recently modified records. The two directions available are asc and desc. If you do not provide a direction asc is assumed. You can sort by any Number, Date or Text field in the Fields Reference below.
The default sort is name asc.
return_format
string
Can be either array or object. The default is object.
When set to array, you will receive a simply array of records inside the 'records' key of the returned parent JSON object.
with_related
boolean
Can be either 1 or 0. Default is 1. When passed, related records to the main returned record are also returned, in a 'related' object.
If you don't need the related records, set this to 0 for a performance improvement.
Authorization
string
Your access token.
Accepts
string
Use application/json
Content-Type
string
Use application/json
Authorization
string
Your access token.
JSON object
object
{
"name": "Auchenflower Aged Care",
"record_status": "prospect",
"assigned_user": 27110,
"description": "A large aged care provider based in Queensland, Australia."
....
}
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.