Enquiries

get
Get an Enquiry

https://api.tiny.plus/v2/enquiries/{{id}}
This endpoint allows you to get a full Enquiry record.
Request
Response
Request
Path Parameters
id
required
number
ID of the enquiry
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
Enquiry successfully retrieved.
{
"id": 1301
"name": "New Project",
"contact_name": "Adam Adamson",
"contact_company": "Adamson Developments",
"contact_email": "adam@adamson.com",
"assigned_user": 1231,
...
}
404: Not Found
Could not find a contact matching the provided ID.
{
"message": "Enquiry not found."
}

Example Usage

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

post
Create an Enquiry

https://api.tiny.plus/v2/enquiries
You can create a new tiny+ enquiry with this endpoint. The only required field to create an Enquiry 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": "New Project", "assigned_user": 27110, "description": "A new aged care facility", "contact_name": "Andrew Xavier", "contact_company": "Xavier Developers" .... }
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.

Enquiries Field Reference

Field

Type

Details

Permission

id

Number

Unique record identifier.

Read-only

name

String (up to 200 characters).

REQUIRED.

Identifying Name / Title.

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

record_status

String (or ID for add/edit)

The current status of this enquiry. Can be either open or closed. When adding/editing, you can pass a record_phase ID here instead of the string if you have configured these.

Full

contact_name

String or ID

When reading, will display either a String if the contact has not been created separately in tiny+, or an ID of the primary related contact if they already exist in tiny+. When editing, you can provide a string, or provide an ID to link to an existing contact.

Full

contact_company

String or ID

When reading, will display either a String if the company has not been created separately in tiny+, or an ID of the primary related company if they already exist in tiny+. When editing, you can provide a string, or provide an ID to link to an existing company.

Full

contact_email

String

The contact's email address.

Full

contact_phone

String

The contact's phone number.

Full

contact_role

String

The contact's role or position.

Full

followup_date

Date

When the enquiry should be followed up. If left blank when adding a new enquiry, defaults to +2 business days.

Full

notes

String

An extra area for notes.

Full

location_id

String

A project's physical address. Will be parsed and geocoded after being added.

Full