# Enquiries
## Get an Enquiry
`GET` `https://api.tiny.plus/v2/enquiries/{{id}}`
This endpoint allows you to get a full Enquiry record.
#### Path Parameters
| Name | Type | Description |
| ---- | ------ | ----------------- |
| id | number | ID of the enquiry |
#### Query Parameters
| Name | Type | Description |
| ------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| with\_related | 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.
|
#### Headers
| Name | Type | Description |
| ------------- | ------ | ------------------ |
| Authorization | string | Your access token. |
{% tabs %}
{% tab title="200 Enquiry successfully retrieved." %}
```javascript
{
"id": 1301
"name": "New Project",
"contact_name": "Adam Adamson",
"contact_company": "Adamson Developments",
"contact_email": "adam@adamson.com",
"assigned_user": 1231,
...
}
```
{% endtab %}
{% tab title="404 Could not find a contact matching the provided ID." %}
```javascript
{
"message": "Enquiry not found."
}
```
{% endtab %}
{% endtabs %}
#### Example Usage
{% tabs %}
{% tab title="jQuery" %}
```javascript
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);
});
```
{% endtab %}
{% tab title="PHP" %}
```php
"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;
} ?>
```
{% endtab %}
{% endtabs %}
## Create an Enquiry
`POST` `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.
#### Headers
| Name | Type | Description |
| ------------- | ------ | ---------------------- |
| Accepts | string | Use `application/json` |
| Content-Type | string | Use `application/json` |
| Authorization | string | Your access token. |
#### Request Body
| Name | Type | Description |
| ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| JSON object | object | {
"name": "New Project",
"assigned\_user": 27110,
"description": "A new aged care facility",
"contact\_name": "Andrew Xavier",
"contact\_company": "Xavier Developers"
....
}
|
{% tabs %}
{% tab title="200 A JSON object is returned with your new tiny+ record ID." %}
```
{
id: [your new ID]
}
```
{% endtab %}
{% tab title="400 If there was a problem adding the record, you'll receive a 400 response." %}
```
{
error: 'Error adding the record.'
}
```
{% endtab %}
{% tab title="403 If you do not have permission to add the record, you'll receive a 403 response." %}
```
```
{% endtab %}
{% endtabs %}
## 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 |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.tiny.plus/api/endpoints/enquiries.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.