tiny+ knowledge base
tiny+ knowledge base
Welcome
Our pitch
Using tiny+
Getting started
Guides
How Tos
Integrations
Advanced topics
API Documentation
Introduction
Getting access
Endpoints
Projects
Companies
Contacts
Enquiries
Marketing Activities
Team Members
Tasks
Meetings
Posts
Powered by GitBook

Companies

get
Get a Company

https://api.tiny.plus/v2/companies/{{id}}
This endpoint allows you to get a full Company record.
Request
Response
Request
Path Parameters
id
required
number
ID of the company
Headers
Authorization
required
string
Your access token.
Query Parameters
with_related
optional
boolean
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.
Response
200: OK
Company successfully retrieved.
{
    "id": 1237
    "name": "Auchenflower Aged Care",
    "record_status": "prospect",
    "description": "A large aged care provider based in Queensland, Australia.",
    "assigned_user": 1231,
    ...
}
404: Not Found
Could not find a company matching the provided ID.
{
    "message": "Company not found."
}

Example Usage

jQuery
PHP
jQuery
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
<?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
List Companies

https://api.tiny.plus/v2/companies
This endpoint allows you to get a paginated list of Companies, optionally filtered by criteria.
Request
Response
Request
Headers
Authorization
required
string
Your access token.
Query Parameters
{{field_name}}
optional
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=1232 To return all projects modified after a date: /projects/?modified_date=>2019-01-01 14:00:00 To return all Active projects: /projects/?record_status=active
with_health
optional
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
optional
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
optional
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
optional
number
Used for pagination. Limit is the number of records to return from the full resultset. The default is 15.
start
optional
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
optional
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
optional
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
optional
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.
Response
200: OK
You will receive a JSON object containing all the relevant company fields.
{
    total_records: 31,
    returned_records: 31,
    records: [
        {
            id: 1237,
            name: 'Auchenflower Aged Care',
            ...
        },
        ...
        {
            id: 849,
            name: 'ZZ Top Homes for the Aged',
            ...
        }
    ]
}

Example Usage

jQuery
PHP
jQuery
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
<?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
Create a Company

https://api.tiny.plus/v2/companies
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.
Request
Response
Request
Headers
Accepts
optional
string
Use application/json
Content-Type
required
string
Use application/json
Authorization
required
string
Your access token.
Body Parameters
JSON object
required
object
{ "name": "Auchenflower Aged Care", "record_status": "prospect", "assigned_user": 27110, "description": "A large aged care provider based in Queensland, Australia." .... }
Response
200: OK
A JSON object is returned with your new tiny+ record ID.
{
    id: [your new ID]
}
400: Bad Request
If there was a problem adding the record, you'll receive a 400 response.
{
    error: 'Error adding the record.'
}
403: Forbidden
If you do not have permission to add the record, you'll receive a 403 response.
​

patch
Update a Company

https://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.
Request
Response
Request
Path Parameters
id
required
number
ID of the company.
Headers
Accepts
optional
string
Use application/json
Content-Type
required
string
Use application/json
Authorization
required
string
Your access token.
Body Parameters
JSON object
required
object
{ "record_status": "active", "assigned_user": 27111 .... }
Response
200: OK
​

delete
Delete a Company

https://api.tiny.plus/v2/companies/{{id}}
Delete a Company record.
Request
Response
Request
Path Parameters
id
required
string
ID of the company.
Headers
Authorization
required
string
Your access token.
Response
200: OK
​
400: Bad Request
​

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 updated 4 months ago
Contents
get
Get a Company
get
List Companies
post
Create a Company
patch
Update a Company
delete
Delete a Company
Companies Field Reference