Comment on page

Contacts

get
https://api.tiny.plus
/v2/contacts/{{id}}
Get a Contact
Example Usage
jQuery
PHP
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
​
$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
https://api.tiny.plus
/v2/contacts
List Contacts
Example Usage
jQuery
PHP
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
​
$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
https://api.tiny.plus
/v2/contacts
Create a Contact
patch
https://api.tiny.plus
/v2/contacts/{{id}}
Update a Contact
delete
https://api.tiny.plus
/v2/contacts/{{id}}
Delete a Contact
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 or JSON object
A link to this contact 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
notes
String
A space for extra notes about this contact.
Full

Companies

Enquiries

Last modified 3yr ago

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 or JSON object	A link to this contact 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
notes	String	A space for extra notes about this contact.	Full