Enquiries

Use the Enquiries endpoints to list, create, retrieve, update, and delete enquiries within the organization associated with your Admin API key.

Endpoints

Method	Endpoint	Description
`GET`	`/enquiries`	List enquiries with filtering and pagination
`POST`	`/enquiries`	Create an enquiry
`GET`	`/enquiries/{enquiryId}`	Get a single enquiry
`PATCH`	`/enquiries/{enquiryId}`	Update an enquiry
`DELETE`	`/enquiries/{enquiryId}`	Delete an enquiry
`GET`	`/metadata/enquiries`	Get valid enquiry metadata for request construction

Test the API

The POST, PATCH, and DELETE testers change live organization data. Your API key is stored only in this browser's local storage, so use the tester on a trusted device.

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Query Parameters

limit?integer

Default50

Range1 <= value <= 100

search?string

status?string

Value in"pending" | "completed" | "cancelled"

categoryId?string

locationId?string

createdBy?string

isInternal?boolean

Response Body

`application/json`

curl -X GET "https://api.tiquo.app/api/v1/enquiries"

{
  "success": true,
  "data": [
    {
      "id": "string",
      "enquiryNumber": "string",
      "name": "string",
      "email": "user@example.com",
      "phone": "string",
      "customerId": "string",
      "type": "string",
      "typeLabel": "string",
      "subject": "string",
      "message": "string",
      "category": "string",
      "orderId": "string",
      "status": "string",
      "lostReason": "string",
      "priority": "low",
      "assignedTo": "string",
      "assignedToStaffIds": [
        "string"
      ],
      "assignedToStaffNames": [
        "string"
      ],
      "source": "string",
      "referrer": "string",
      "firstResponseAt": "2019-08-24T14:15:22Z",
      "resolvedAt": "2019-08-24T14:15:22Z",
      "responseCount": 0,
      "totalOrdersValue": 0,
      "totalPaid": 0,
      "orderCount": 0,
      "customFields": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "pageSize": 0
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Request Body

application/json

name*string

email*string

Formatemail

phone?string

customerId?string

type*string

status?string

subject*string

message*string

category?string

Default"general"

priority?string

Default"medium"

Value in"low" | "medium" | "high" | "urgent"

source?string

Default"admin"

Response Body

`application/json`

curl -X POST "https://api.tiquo.app/api/v1/enquiries" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "email": "user@example.com",    "type": "string",    "subject": "string",    "message": "string"  }'

{
  "success": true,
  "data": {
    "id": "string",
    "enquiryNumber": "string",
    "name": "string",
    "email": "user@example.com",
    "phone": "string",
    "customerId": "string",
    "type": "string",
    "typeLabel": "string",
    "subject": "string",
    "message": "string",
    "category": "string",
    "orderId": "string",
    "status": "string",
    "lostReason": "string",
    "priority": "low",
    "assignedTo": "string",
    "assignedToStaffIds": [
      "string"
    ],
    "assignedToStaffNames": [
      "string"
    ],
    "source": "string",
    "referrer": "string",
    "firstResponseAt": "2019-08-24T14:15:22Z",
    "resolvedAt": "2019-08-24T14:15:22Z",
    "responseCount": 0,
    "totalOrdersValue": 0,
    "totalPaid": 0,
    "orderCount": 0,
    "customFields": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Path Parameters

enquiryId*string

Enquiry number or document ID

Response Body

`application/json`

curl -X GET "https://api.tiquo.app/api/v1/enquiries/string"

{
  "success": true,
  "data": {
    "id": "string",
    "enquiryNumber": "string",
    "name": "string",
    "email": "user@example.com",
    "phone": "string",
    "customerId": "string",
    "type": "string",
    "typeLabel": "string",
    "subject": "string",
    "message": "string",
    "category": "string",
    "orderId": "string",
    "status": "string",
    "lostReason": "string",
    "priority": "low",
    "assignedTo": "string",
    "assignedToStaffIds": [
      "string"
    ],
    "assignedToStaffNames": [
      "string"
    ],
    "source": "string",
    "referrer": "string",
    "firstResponseAt": "2019-08-24T14:15:22Z",
    "resolvedAt": "2019-08-24T14:15:22Z",
    "responseCount": 0,
    "totalOrdersValue": 0,
    "totalPaid": 0,
    "orderCount": 0,
    "customFields": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Path Parameters

enquiryId*string

Request Body

application/json

[key: string]?any

Response Body

`application/json`

curl -X PATCH "https://api.tiquo.app/api/v1/enquiries/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true,
  "data": {
    "id": "string",
    "enquiryNumber": "string",
    "name": "string",
    "email": "user@example.com",
    "phone": "string",
    "customerId": "string",
    "type": "string",
    "typeLabel": "string",
    "subject": "string",
    "message": "string",
    "category": "string",
    "orderId": "string",
    "status": "string",
    "lostReason": "string",
    "priority": "low",
    "assignedTo": "string",
    "assignedToStaffIds": [
      "string"
    ],
    "assignedToStaffNames": [
      "string"
    ],
    "source": "string",
    "referrer": "string",
    "firstResponseAt": "2019-08-24T14:15:22Z",
    "resolvedAt": "2019-08-24T14:15:22Z",
    "responseCount": 0,
    "totalOrdersValue": 0,
    "totalPaid": 0,
    "orderCount": 0,
    "customFields": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Path Parameters

enquiryId*string

Response Body

`application/json`

curl -X DELETE "https://api.tiquo.app/api/v1/enquiries/string"

Empty

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Authorization

BearerAuth

AuthorizationBearer <token>

API key from the Tiquo dashboard (Settings > Developer > Admin API)

In: header

Response Body

`application/json`

curl -X GET "https://api.tiquo.app/api/v1/metadata/enquiries"

{}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

For every request field, filter, response schema, and error response, use the operation details in the interactive reference above.

Enquiries

200application/json

401application/json

403application/json

500application/json

201application/json

400application/json

401application/json

403application/json

200application/json

401application/json

403application/json

404application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

200

400application/json

401application/json

403application/json

404application/json

200application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`