Contacts

get
Get a Contact

https://api.tiny.plus/v2/contacts/{{id}}
This endpoint allows you to get a full Contact record.
Request
Response
Request
Path Parameters
id
required
number
ID of the contact
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
Contact successfully retrieved.
{
"id": 1241
"name": "Adam Adamson",
"first_name": "Adam",
"last_name": "Adamson",
"email_address": "adam@adamson.com",
"primary_company": 1237,
"title": "CEO",
"assigned_user": 1231,
...
}
404: Not Found
Could not find a contact matching the provided ID.
{
"message": "Contact not found."
}

Example Usage

jQuery
PHP
jQuery
var settings = {
"url": "https://api.tiny.plus/v2/contacts/{{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/contacts/{{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 Contacts

https://api.tiny.plus/v2/contacts
This endpoint allows you to get a paginated list of Contacts, 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 contacts for user 1232: /contacts/?assigned_user=1232 To return all contacts modified after a date: /contacts/?modified_date=>2019-01-01 14:00:00
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 Related Team Members.
subscribed
optional
string
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 Related Team Members, 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/contacts?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/contacts?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 Contact

https://api.tiny.plus/v2/contacts
You can create a new tiny+ contact with this endpoint. The only required field to create a Contact 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.
Query Parameters
return_record
optional
boolean
Add this parameter to get a copy of the newly created record. Save yourself a call!
Body Parameters
JSON object
required
object
{ "name": "Alex Amorosi", "assigned_user": 27110, "title": "Founder", "direct_tel": "02 9911 0222", "email_address": "alex@company.com" .... }
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 Contact

https://api.tiny.plus/v2/contacts/{{id}}
You can edit a tiny+ Contact with this endpoint. Note: you only need to pass the field(s) you wish to change.
Request
Response
Request
Path Parameters
id
required
number
ID of the contact.
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
{ "assigned_user": 27111, "direct_tel": "02 9999 1020" }
Response
200: OK

delete
Delete a Contact

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

Contacts Field Reference

Field

Type

Details

Permission

id

Number

Unique record identifier.

Read-only

name

String (up to 200 characters).

REQUIRED.

Contact Name. eg. Andrew Anderson

Full

first_name

String

Optionally, you can create / edit a contact as First Name and Last Name instead of the name field. If you do not provide this field, we will generate this value based on the name field.

Full

last_name

String

(As above)

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_url

String

The fully qualified URI of the record.

Read-only

title

String

The title or position of this contact. eg. Development Director.

Full

email_address

String (Email Address)

Must be a valid email address in RFC 822 syntax. Invalid entries are ignored.

Full

linkedin

String

A URL to the contact's LinkedIn page.

Full

twitter

String

A Twitter @handle.

Full

mobile

String

Mobile telephone number.

Full

office_tel

String

Office telephone number.

Full

direct_tel

String

Direct Line telephone number.

Full

physical_address1

String

Address - Line 1

Full

physical_address2

String

Address - Line 2

Full

physical_town

String

Address - the Town/City/Locality.

Full

physical_state

String

Address - the State or Province.

Full

physical_postcode

String

Address - the Postal Code or Region Code.

Full

physical_country

String

Address - the Country.

Full

external_url

String

A link to this contact in another system. Helpful when used with sync_origin.

Full

notes

String

A space for extra notes about this contact.

Full