API and AuthenticationAdmin API
Admin API
Server-side API for managing your organization data
Admin API
The Admin API gives backend systems permission-scoped access to your organization's data on Tiquo. Use it to build integrations, sync data with other platforms, automate workflows, and more.
Base URL
https://api.tiquo.app/api/v1Authentication
All Admin API requests require an API key in the Authorization header:
curl -X GET "https://api.tiquo.app/api/v1/customers/CUST-000001" \
-H "Authorization: Bearer your_api_key_here"API keys are organization-scoped. You can create and manage them from Settings > Admin API in your Tiquo dashboard.
Rate Limits
The default limit is 1,000 requests per API key in a fixed one-hour window. If you exceed it, the API returns 429 Too Many Requests until the current window resets.
Contact Tiquo if your integration needs a higher rate limit. Rate limits cannot be changed from the dashboard.
Available Endpoints
| Resource | Endpoints | Status |
|---|---|---|
| Customers | GET /customers, POST /customers, GET /customers/{customerId}, PATCH /customers/{customerId}, GET /customers/{customerId}/store-credit, POST /customers/{customerId}/store-credit | Available |
| Companies | GET /companies, POST /companies, GET /companies/{companyId}, PATCH /companies/{companyId}, POST /companies/{companyId}/store-credit | Available |
| Orders | GET /orders, POST /orders, GET /orders/{orderId}, PATCH /orders/{orderId}, DELETE /orders/{orderId} | Available |
| Bookings | GET /bookings, POST /bookings, GET /bookings/{bookingId}, PATCH /bookings/{bookingId}, DELETE /bookings/{bookingId}, GET /bookings/{bookingId}/ticket | Available |
| Enquiries | GET /enquiries, POST /enquiries, GET /enquiries/{enquiryId}, PATCH /enquiries/{enquiryId}, DELETE /enquiries/{enquiryId} | Available |
| Tasks | GET /tasks, POST /tasks, GET /tasks/{taskId}, PATCH /tasks/{taskId}, DELETE /tasks/{taskId} | Available |
| Metadata | GET /metadata/enquiries, GET /metadata/customer-parameters, GET /metadata/options/{kind} | Available |
| Account and webhook subscriptions | GET /account, POST /zapier/subscriptions, DELETE /zapier/subscriptions/{subscriptionId} | Available |
Complete API Reference
The reference below is generated directly from the production OpenAPI contract. It contains every currently deployed operation, parameter, request body, response, and schema. Enter your Admin API key in an operation's authorization field to test it directly from this page.
The tester sends requests to the live production API. POST and PATCH requests change 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
Response Body
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/account"{
"success": true,
"data": {
"id": "string",
"name": "string",
"slug": "string",
"permissions": [
"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
event*string
Value in
"customer.created" | "company.created" | "order.created" | "booking.created" | "booking.confirmed" | "enquiry.created" | "task.created"events?array<>
Items
1 <= itemstargetUrl?string
Unique HTTPS callback URL issued by hooks.zapier.com.
Format
uri[key: string]?never
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/zapier/subscriptions" \ -H "Content-Type: application/json" \ -d '{ "targetUrl": "http://example.com" }'{
"success": true,
"data": {
"id": "string",
"unsubscribeToken": "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"
}{
"success": false,
"error": "string",
"timestamp": "2019-08-24T14:15:22Z"
}Path Parameters
subscriptionId*string
Header Parameters
X-Tiquo-Unsubscribe-Token*string
Opaque token returned when the subscription was created.
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://api.tiquo.app/api/v1/zapier/subscriptions/string" \ -H "X-Tiquo-Unsubscribe-Token: string"{
"success": true,
"data": {
"id": "string",
"deleted": true
},
"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
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100cursor?string
Opaque continuation cursor returned by the previous page.
cursor?string
Pagination cursor from a previous response
search?string
Full-text search across name, email, phone, customer number. Cannot be combined with parameterId/parameterName.
status?string
Value in
"active" | "inactive" | "banned"parameterId?string
Filter to customers that have this parameter set. Use the system parameter ID (e.g. "system_marketing_opt_in") or the schema document ID for custom parameters. Cannot be combined with search.
parameterName?string
Filter to customers that have this parameter set, looked up by name (e.g. "Marketing Opt-In"). Alternative to parameterId. Cannot be combined with search.
parameterValue?string
When combined with parameterId or parameterName, only return customers whose parameter matches this exact value.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/customers"{
"success": true,
"data": [
{
"id": "string",
"customerNumber": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"emails": [
{
"address": "user@example.com",
"isPrimary": true
}
],
"phones": [
{
"number": "string",
"isPrimary": true
}
],
"profilePhoto": "string",
"status": "active",
"source": "string",
"totalOrders": 0,
"totalSpent": 0,
"averageOrderValue": 0,
"lifetimeValue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0
}
],
"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
firstName?string
lastName?string
displayName?string
emails?array<>
phones?array<>
customerNumber?string
Custom ID (5-32 chars). Auto-generated if omitted.
status?string
Default
"active"Value in
"active" | "inactive" | "banned"source?string
Default
"admin"profilePhoto?string
Format
uriResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/customers" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"data": {
"id": "string",
"customerNumber": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"emails": [
{
"address": "user@example.com",
"isPrimary": true
}
],
"phones": [
{
"number": "string",
"isPrimary": true
}
],
"profilePhoto": "string",
"status": "active",
"source": "string",
"totalOrders": 0,
"totalSpent": 0,
"averageOrderValue": 0,
"lifetimeValue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0,
"marketingOptIn": true,
"smsOptIn": true
},
"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
customerId*string
Customer number, email, phone, or document ID
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/customers/string"{
"success": true,
"data": {
"id": "string",
"customerNumber": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"emails": [
{
"address": "user@example.com",
"isPrimary": true
}
],
"phones": [
{
"number": "string",
"isPrimary": true
}
],
"profilePhoto": "string",
"status": "active",
"source": "string",
"totalOrders": 0,
"totalSpent": 0,
"averageOrderValue": 0,
"lifetimeValue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0,
"marketingOptIn": true,
"smsOptIn": true
},
"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
customerId*string
Customer number or document ID
Request Body
application/json
firstName?string
lastName?string
displayName?string
emails?array<>
phones?array<>
customerNumber?string
status?string
Value in
"active" | "inactive" | "banned"source?string
profilePhoto?string
URL, data-URI, or empty string to remove
profilePhotoBase64?string
Raw base64-encoded image (alternative to profilePhoto)
profilePhotoMimeType?string
MIME type when using profilePhotoBase64 (e.g. image/png)
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://api.tiquo.app/api/v1/customers/string" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"data": {
"id": "string",
"customerNumber": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"emails": [
{
"address": "user@example.com",
"isPrimary": true
}
],
"phones": [
{
"number": "string",
"isPrimary": true
}
],
"profilePhoto": "string",
"status": "active",
"source": "string",
"totalOrders": 0,
"totalSpent": 0,
"averageOrderValue": 0,
"lifetimeValue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0,
"marketingOptIn": true,
"smsOptIn": true
},
"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"
}{
"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
customerId*string
Customer number or document ID
Query Parameters
currency?string
Optional 3-letter ISO currency code to return one balance.
Match
^[A-Za-z]{3}$Length
3 <= length <= 3Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/customers/string/store-credit"{
"success": true,
"data": {
"customerId": "string",
"customerNumber": "string",
"balances": [
{
"currency": "GBP",
"balance": 25.5
}
],
"totalCurrencies": 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"
}{
"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
customerId*string
Customer number or document ID
Header Parameters
Idempotency-Key*string
Unique key for this store-credit issuance attempt. Reusing the same key with the same request returns the original transaction; reusing it with different request details returns 409.
Match
^[A-Za-z0-9._:-]+$Length
1 <= length <= 128Request Body
application/json
amount*number
Positive amount to add to the balance.
Multiple Of
0.01Range
0 < value <= 1000000currency*string
Match
^[A-Za-z]{3}$Length
3 <= length <= 3note?string
Optional note for the ledger entry.
Length
length <= 500[key: string]?never
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/customers/string/store-credit" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "amount": 1000000, "currency": "GBP" }'{
"success": true,
"data": {
"id": "string",
"entityType": "customer",
"customerId": "string",
"companyId": "string",
"currency": "string",
"type": "issued",
"amount": 0,
"balanceAfter": 0,
"note": "string",
"idempotencyKey": "string",
"createdAt": 0,
"idempotentReplay": true
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": true,
"data": {
"id": "string",
"entityType": "customer",
"customerId": "string",
"companyId": "string",
"currency": "string",
"type": "issued",
"amount": 0,
"balanceAfter": 0,
"note": "string",
"idempotencyKey": "string",
"createdAt": 0,
"idempotentReplay": true
},
"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"
}{
"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
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100status?string
Value in
"active" | "inactive" | "archived"search?string
type?string
Value in
"client" | "prospect" | "vendor" | "partner" | "other"industry?string
companySize?string
tag?string
emailDomain?string
customFieldKey?string
customFieldValue?string
Response Body
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/companies"{
"success": true,
"data": [
{
"id": "string",
"companyNumber": "string",
"name": "string",
"displayName": "string",
"email": "string",
"phone": "string",
"website": "string",
"websites": [
"string"
],
"emailDomains": [
"string"
],
"status": "active",
"tags": [
"string"
],
"totalCustomers": 0,
"totalOrders": 0,
"totalRevenue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0
}
],
"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"
}Authorization
BearerAuth AuthorizationBearer <token>
API key from the Tiquo dashboard (Settings > Developer > Admin API)
In: header
Request Body
application/json
name*string
displayName?string
email?string
Format
emailphone?string
website?string
Format
uriwebsites?array<>
emailDomains?array<>
description?string
industry?string
companySize?string
status?string
Value in
"active" | "inactive" | "archived"type?string
Value in
"client" | "prospect" | "vendor" | "partner" | "other"customFields?
tags?array<>
notes?string
address?
logo?string
logoBase64?string
logoMimeType?string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/companies" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"success": true,
"data": {
"id": "string",
"companyNumber": "string",
"name": "string",
"displayName": "string",
"email": "string",
"phone": "string",
"website": "string",
"websites": [
"string"
],
"emailDomains": [
"string"
],
"status": "active",
"tags": [
"string"
],
"totalCustomers": 0,
"totalOrders": 0,
"totalRevenue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0,
"description": "string",
"logo": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"industry": "string",
"companySize": "1-10",
"type": "client",
"notes": "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"
}{
"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
companyId*string
Company number, email, document ID, or name
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/companies/string"{
"success": true,
"data": {
"id": "string",
"companyNumber": "string",
"name": "string",
"displayName": "string",
"email": "string",
"phone": "string",
"website": "string",
"websites": [
"string"
],
"emailDomains": [
"string"
],
"status": "active",
"tags": [
"string"
],
"totalCustomers": 0,
"totalOrders": 0,
"totalRevenue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0,
"description": "string",
"logo": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"industry": "string",
"companySize": "1-10",
"type": "client",
"notes": "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
companyId*string
Company number or document ID
Request Body
application/json
name?string
displayName?string
description?string
email?string
Format
emailphone?string
website?string
Format
uriwebsites?array<>
emailDomains?array<>
logo?string
URL, data-URI, or empty string to remove
logoBase64?string
Raw base64-encoded image (alternative to logo)
logoMimeType?string
MIME type when using logoBase64 (e.g. image/png)
address?
industry?string
companySize?string
Value in
"1-10" | "11-50" | "51-200" | "201-500" | "501-1000" | "1000+"status?string
Value in
"active" | "inactive" | "archived"type?string
Value in
"client" | "prospect" | "vendor" | "partner" | "other"tags?array<>
notes?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://api.tiquo.app/api/v1/companies/string" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"data": {
"id": "string",
"companyNumber": "string",
"name": "string",
"displayName": "string",
"email": "string",
"phone": "string",
"website": "string",
"websites": [
"string"
],
"emailDomains": [
"string"
],
"status": "active",
"tags": [
"string"
],
"totalCustomers": 0,
"totalOrders": 0,
"totalRevenue": 0,
"lastOrderDate": 0,
"lastActivityDate": 0,
"createdAt": 0,
"updatedAt": 0,
"description": "string",
"logo": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"industry": "string",
"companySize": "1-10",
"type": "client",
"notes": "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"
}{
"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
companyId*string
Company number or document ID
Header Parameters
Idempotency-Key*string
Unique key for this store-credit issuance attempt. Reusing the same key with the same request returns the original transaction; reusing it with different request details returns 409.
Match
^[A-Za-z0-9._:-]+$Length
1 <= length <= 128Request Body
application/json
amount*number
Positive amount to add to the balance.
Multiple Of
0.01Range
0 < value <= 1000000currency*string
Match
^[A-Za-z]{3}$Length
3 <= length <= 3note?string
Optional note for the ledger entry.
Length
length <= 500[key: string]?never
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/companies/string/store-credit" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "amount": 1000000, "currency": "GBP" }'{
"success": true,
"data": {
"id": "string",
"entityType": "customer",
"customerId": "string",
"companyId": "string",
"currency": "string",
"type": "issued",
"amount": 0,
"balanceAfter": 0,
"note": "string",
"idempotencyKey": "string",
"createdAt": 0,
"idempotentReplay": true
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": true,
"data": {
"id": "string",
"entityType": "customer",
"customerId": "string",
"companyId": "string",
"currency": "string",
"type": "issued",
"amount": 0,
"balanceAfter": 0,
"note": "string",
"idempotencyKey": "string",
"createdAt": 0,
"idempotentReplay": true
},
"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"
}{
"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
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100cursor?string
search?string
Search by order number, customer name/email
status?string
Comma-separated: draft,pending,processing,completed,cancelled,refunded,open_tab
paymentStatus?string
Comma-separated payment statuses
source?string
channel?string
currency?string
sublocationId?string
customerId?string
customerEmail?string
Format
emaildateFrom?string
Filter by order createdAt, inclusive
Format
datedateTo?string
Format
datesource?string
serviceId?string
sublocationId?string
customerId?string
attendeeCountMin?integer
Range
0 <= valueattendeeCountMax?integer
Filter by order createdAt, inclusive
Range
0 <= valueupdatedAfter?string
Return orders whose updatedAt is strictly after this instant. Results are ordered by updatedAt ascending so integrations can follow all pagination cursors and then advance their update watermark. Cannot be combined with search.
Format
date-timeamountMin?number
amountMax?number
Response Body
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/orders"{
"success": true,
"data": [
{
"id": "string",
"orderNumber": "string",
"status": "draft",
"paymentStatus": "pending",
"source": "string",
"channel": "string",
"total": 0,
"subtotal": 0,
"tax": 0,
"discount": 0,
"discountName": "string",
"serviceChargeAmount": 0,
"serviceChargePercentage": 0,
"serviceChargeRemoved": true,
"payments": [
{
"id": "string",
"method": "string",
"provider": "stripe",
"amount": 0,
"currency": "GBP",
"paymentIntentId": "string",
"chargeId": "string",
"cardBrand": "visa",
"cardLast4": "4242",
"walletType": "apple_pay",
"paidAt": 0
}
],
"storeCredit": {
"amount": 0,
"currency": "string"
},
"tipAmount": 0,
"currency": "string",
"itemCount": 0,
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"staffId": "string",
"staffName": "string",
"locationId": "string",
"locationName": "string",
"sublocationId": "string",
"sublocationName": "string",
"covers": 0,
"tableNumber": "string",
"tableName": "string",
"tables": [
{
"id": "string",
"number": "string",
"name": "string"
}
],
"refundAmount": 0,
"createdAt": 0,
"updatedAt": 0
}
],
"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"
}Authorization
BearerAuth AuthorizationBearer <token>
API key from the Tiquo dashboard (Settings > Developer > Admin API)
In: header
Request Body
application/json
sublocationId*string
customerId?string
companyId?string
parentBookingId?string
enquiryId?string
source?string
Default
"admin"Value in
"pos" | "online" | "admin"channel?string
Default
"zapier"orderType?string
Value in
"eat_in" | "take_away"status?string
Default
"draft"Value in
"draft" | "pending" | "processing" | "completed" | "cancelled" | "refunded" | "open_tab" | "lost_cart"notes?string
idempotencyKey?string
items*array<>
Items
1 <= itemsResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/orders" \ -H "Content-Type: application/json" \ -d '{ "sublocationId": "string", "items": [ { "name": "string", "quantity": 0, "unitPrice": 0 } ] }'{
"success": true,
"data": {
"id": "string",
"orderNumber": "string",
"status": "draft",
"paymentStatus": "pending",
"source": "string",
"channel": "string",
"total": 0,
"subtotal": 0,
"tax": 0,
"discount": 0,
"discountName": "string",
"serviceChargeAmount": 0,
"serviceChargePercentage": 0,
"serviceChargeRemoved": true,
"payments": [
{
"id": "string",
"method": "string",
"provider": "stripe",
"amount": 0,
"currency": "GBP",
"paymentIntentId": "string",
"chargeId": "string",
"cardBrand": "visa",
"cardLast4": "4242",
"walletType": "apple_pay",
"paidAt": 0
}
],
"storeCredit": {
"amount": 0,
"currency": "string"
},
"tipAmount": 0,
"currency": "string",
"itemCount": 0,
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"staffId": "string",
"staffName": "string",
"locationId": "string",
"locationName": "string",
"sublocationId": "string",
"sublocationName": "string",
"covers": 0,
"tableNumber": "string",
"tableName": "string",
"tables": [
{
"id": "string",
"number": "string",
"name": "string"
}
],
"refundAmount": 0,
"createdAt": 0,
"updatedAt": 0,
"paymentMethod": "string",
"shipping": 0,
"items": [
{
"id": "string",
"type": "product",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"subtotal": 0,
"tax": 0,
"taxRate": 0,
"discount": 0,
"total": 0,
"sku": "string",
"productId": "string",
"categoryName": "string",
"reportingCategory": "string",
"bookingId": "string",
"productStatus": "string",
"bookingStatus": "string",
"specialInstructions": "string",
"orderStageName": "string"
}
],
"discountCodes": [
"string"
],
"customerNotes": "string",
"refundReason": "string",
"isLegacy": true,
"creationMethod": "customer_online",
"completedAt": 0,
"cancelledAt": 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"
}{
"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
orderId*string
Order number or document ID
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/orders/string"{
"success": true,
"data": {
"id": "string",
"orderNumber": "string",
"status": "draft",
"paymentStatus": "pending",
"source": "string",
"channel": "string",
"total": 0,
"subtotal": 0,
"tax": 0,
"discount": 0,
"discountName": "string",
"serviceChargeAmount": 0,
"serviceChargePercentage": 0,
"serviceChargeRemoved": true,
"payments": [
{
"id": "string",
"method": "string",
"provider": "stripe",
"amount": 0,
"currency": "GBP",
"paymentIntentId": "string",
"chargeId": "string",
"cardBrand": "visa",
"cardLast4": "4242",
"walletType": "apple_pay",
"paidAt": 0
}
],
"storeCredit": {
"amount": 0,
"currency": "string"
},
"tipAmount": 0,
"currency": "string",
"itemCount": 0,
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"staffId": "string",
"staffName": "string",
"locationId": "string",
"locationName": "string",
"sublocationId": "string",
"sublocationName": "string",
"covers": 0,
"tableNumber": "string",
"tableName": "string",
"tables": [
{
"id": "string",
"number": "string",
"name": "string"
}
],
"refundAmount": 0,
"createdAt": 0,
"updatedAt": 0,
"paymentMethod": "string",
"shipping": 0,
"items": [
{
"id": "string",
"type": "product",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"subtotal": 0,
"tax": 0,
"taxRate": 0,
"discount": 0,
"total": 0,
"sku": "string",
"productId": "string",
"categoryName": "string",
"reportingCategory": "string",
"bookingId": "string",
"productStatus": "string",
"bookingStatus": "string",
"specialInstructions": "string",
"orderStageName": "string"
}
],
"discountCodes": [
"string"
],
"customerNotes": "string",
"refundReason": "string",
"isLegacy": true,
"creationMethod": "customer_online",
"completedAt": 0,
"cancelledAt": 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
Path Parameters
orderId*string
Request Body
application/json
status*string
Value in
"draft" | "pending" | "processing" | "completed" | "cancelled" | "refunded"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://api.tiquo.app/api/v1/orders/string" \ -H "Content-Type: application/json" \ -d '{ "status": "draft" }'{
"success": true,
"data": {
"id": "string",
"orderNumber": "string",
"status": "draft",
"paymentStatus": "pending",
"source": "string",
"channel": "string",
"total": 0,
"subtotal": 0,
"tax": 0,
"discount": 0,
"discountName": "string",
"serviceChargeAmount": 0,
"serviceChargePercentage": 0,
"serviceChargeRemoved": true,
"payments": [
{
"id": "string",
"method": "string",
"provider": "stripe",
"amount": 0,
"currency": "GBP",
"paymentIntentId": "string",
"chargeId": "string",
"cardBrand": "visa",
"cardLast4": "4242",
"walletType": "apple_pay",
"paidAt": 0
}
],
"storeCredit": {
"amount": 0,
"currency": "string"
},
"tipAmount": 0,
"currency": "string",
"itemCount": 0,
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"staffId": "string",
"staffName": "string",
"locationId": "string",
"locationName": "string",
"sublocationId": "string",
"sublocationName": "string",
"covers": 0,
"tableNumber": "string",
"tableName": "string",
"tables": [
{
"id": "string",
"number": "string",
"name": "string"
}
],
"refundAmount": 0,
"createdAt": 0,
"updatedAt": 0,
"paymentMethod": "string",
"shipping": 0,
"items": [
{
"id": "string",
"type": "product",
"name": "string",
"quantity": 0,
"unitPrice": 0,
"subtotal": 0,
"tax": 0,
"taxRate": 0,
"discount": 0,
"total": 0,
"sku": "string",
"productId": "string",
"categoryName": "string",
"reportingCategory": "string",
"bookingId": "string",
"productStatus": "string",
"bookingStatus": "string",
"specialInstructions": "string",
"orderStageName": "string"
}
],
"discountCodes": [
"string"
],
"customerNotes": "string",
"refundReason": "string",
"isLegacy": true,
"creationMethod": "customer_online",
"completedAt": 0,
"cancelledAt": 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"
}{
"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
orderId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://api.tiquo.app/api/v1/orders/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
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100search?string
type?string
status?string
priority?string
Value in
"low" | "medium" | "high" | "urgent"source?string
category?string
email?string
Format
emailcustomerId?string
assignedTo?string
customFieldKey?string
customFieldValue?string
search?string
Search by booking number, customer name/email
status?string
Comma-separated: draft,scheduled,confirmed,reminder_sent,waiting_room,waiting_list,checked_in,active,in_progress,completed,cancelled,no_show,rescheduled
dateFrom?string
Format
datedateTo?string
Format
dateResponse Body
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/bookings"{
"success": true,
"data": [
{
"id": "string",
"bookingNumber": "string",
"status": "draft",
"date": 0,
"startTime": "string",
"endTime": "string",
"duration": 0,
"attendeeCount": 0,
"source": "string",
"serviceId": "string",
"serviceName": "string",
"serviceGroupName": "string",
"sublocationId": "string",
"sublocationName": "string",
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"parentOrderId": "string",
"orderNumber": "string",
"orderValue": 0,
"orderPaymentStatus": "string",
"createdAt": 0,
"updatedAt": 0
}
],
"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"
}Authorization
BearerAuth AuthorizationBearer <token>
API key from the Tiquo dashboard (Settings > Developer > Admin API)
In: header
Request Body
application/json
serviceId*string
sublocationId*string
customerId?string
parentOrderId?string
date*|
startTime?string
endTime?string
duration*number
Range
0 < valuenights?integer
Range
1 <= valuetimezone?string
attendeeCount?integer
Range
1 <= valueadults?integer
Range
0 <= valuechildren?integer
Range
0 <= valueamount?number
Range
0 <= valuesource?string
Default
"admin"customerNotes?string
status?string
Default
"scheduled"Value in
"scheduled"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/bookings" \ -H "Content-Type: application/json" \ -d '{ "serviceId": "string", "sublocationId": "string", "date": "2019-08-24T14:15:22Z", "duration": 0 }'{
"success": true,
"data": {
"id": "string",
"bookingNumber": "string",
"status": "draft",
"date": 0,
"startTime": "string",
"endTime": "string",
"duration": 0,
"attendeeCount": 0,
"source": "string",
"serviceId": "string",
"serviceName": "string",
"serviceGroupName": "string",
"sublocationId": "string",
"sublocationName": "string",
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"parentOrderId": "string",
"orderNumber": "string",
"orderValue": 0,
"orderPaymentStatus": "string",
"createdAt": 0,
"updatedAt": 0,
"timezone": "string",
"attendees": [
{
"name": "string",
"email": "string",
"phone": "string"
}
],
"customerNotes": "string",
"internalNotes": "string",
"isLegacy": true,
"completedAt": 0,
"cancelledAt": 0,
"checkedInAt": 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"
}{
"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
bookingId*string
Booking number, confirmation code, or document ID
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/bookings/string"{
"success": true,
"data": {
"id": "string",
"bookingNumber": "string",
"status": "draft",
"date": 0,
"startTime": "string",
"endTime": "string",
"duration": 0,
"attendeeCount": 0,
"source": "string",
"serviceId": "string",
"serviceName": "string",
"serviceGroupName": "string",
"sublocationId": "string",
"sublocationName": "string",
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"parentOrderId": "string",
"orderNumber": "string",
"orderValue": 0,
"orderPaymentStatus": "string",
"createdAt": 0,
"updatedAt": 0,
"timezone": "string",
"attendees": [
{
"name": "string",
"email": "string",
"phone": "string"
}
],
"customerNotes": "string",
"internalNotes": "string",
"isLegacy": true,
"completedAt": 0,
"cancelledAt": 0,
"checkedInAt": 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
Path Parameters
bookingId*string
Request Body
application/json
status*string
cancellationReason?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://api.tiquo.app/api/v1/bookings/string" \ -H "Content-Type: application/json" \ -d '{ "status": "string" }'{
"success": true,
"data": {
"id": "string",
"bookingNumber": "string",
"status": "draft",
"date": 0,
"startTime": "string",
"endTime": "string",
"duration": 0,
"attendeeCount": 0,
"source": "string",
"serviceId": "string",
"serviceName": "string",
"serviceGroupName": "string",
"sublocationId": "string",
"sublocationName": "string",
"customerId": "string",
"customerName": "string",
"customerEmail": "string",
"parentOrderId": "string",
"orderNumber": "string",
"orderValue": 0,
"orderPaymentStatus": "string",
"createdAt": 0,
"updatedAt": 0,
"timezone": "string",
"attendees": [
{
"name": "string",
"email": "string",
"phone": "string"
}
],
"customerNotes": "string",
"internalNotes": "string",
"isLegacy": true,
"completedAt": 0,
"cancelledAt": 0,
"checkedInAt": 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"
}{
"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
bookingId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://api.tiquo.app/api/v1/bookings/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
Path Parameters
bookingId*string
Booking number or document ID
Response Body
application/pdf
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/bookings/string/ticket""string"{
"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
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100search?string
status?string
Value in
"pending" | "completed" | "cancelled"categoryId?string
locationId?string
createdBy?string
isInternal?boolean
Response Body
application/json
application/json
application/json
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
Format
emailphone?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
application/json
application/json
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
application/json
application/json
application/json
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
application/json
application/json
application/json
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
application/json
application/json
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
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/tasks"{
"success": true,
"data": [
{
"id": "string",
"type": "note",
"title": "string",
"content": "string",
"categoryId": "string",
"categoryName": "string",
"locationId": "string",
"locationName": "string",
"isTask": true,
"taskDueDate": "2019-08-24T14:15:22Z",
"taskRecurrence": {
"frequency": "daily",
"customIntervalDays": 1
},
"taskRecurrenceCompletedCount": 0,
"taskStatus": "pending",
"taskCompletedAt": "2019-08-24T14:15:22Z",
"taskCompletedBy": "string",
"isPinned": true,
"isInternal": true,
"customerIds": [
"string"
],
"enquiryIds": [
"string"
],
"orderIds": [
"string"
],
"sublocationIds": [
"string"
],
"companyIds": [
"string"
],
"staffIds": [
"string"
],
"staffNames": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"createdByName": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedByName": "string"
}
],
"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
title?string
content*string
categoryId?string
locationId?string
taskDueDate?string
Format
date-timetaskRecurrence?
status?string
Default
"pending"Value in
"pending"isPinned?boolean
isInternal?boolean
customerIds?array<>
enquiryIds?array<>
orderIds?array<>
sublocationIds?array<>
companyIds?array<>
staffIds?array<>
staffNames?array<>
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.tiquo.app/api/v1/tasks" \ -H "Content-Type: application/json" \ -d '{ "content": "string" }'{
"success": true,
"data": {
"id": "string",
"type": "note",
"title": "string",
"content": "string",
"categoryId": "string",
"categoryName": "string",
"locationId": "string",
"locationName": "string",
"isTask": true,
"taskDueDate": "2019-08-24T14:15:22Z",
"taskRecurrence": {
"frequency": "daily",
"customIntervalDays": 1
},
"taskRecurrenceCompletedCount": 0,
"taskStatus": "pending",
"taskCompletedAt": "2019-08-24T14:15:22Z",
"taskCompletedBy": "string",
"isPinned": true,
"isInternal": true,
"customerIds": [
"string"
],
"enquiryIds": [
"string"
],
"orderIds": [
"string"
],
"sublocationIds": [
"string"
],
"companyIds": [
"string"
],
"staffIds": [
"string"
],
"staffNames": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"createdByName": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedByName": "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
taskId*string
Task document ID
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/tasks/string"{
"success": true,
"data": {
"id": "string",
"type": "note",
"title": "string",
"content": "string",
"categoryId": "string",
"categoryName": "string",
"locationId": "string",
"locationName": "string",
"isTask": true,
"taskDueDate": "2019-08-24T14:15:22Z",
"taskRecurrence": {
"frequency": "daily",
"customIntervalDays": 1
},
"taskRecurrenceCompletedCount": 0,
"taskStatus": "pending",
"taskCompletedAt": "2019-08-24T14:15:22Z",
"taskCompletedBy": "string",
"isPinned": true,
"isInternal": true,
"customerIds": [
"string"
],
"enquiryIds": [
"string"
],
"orderIds": [
"string"
],
"sublocationIds": [
"string"
],
"companyIds": [
"string"
],
"staffIds": [
"string"
],
"staffNames": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"createdByName": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedByName": "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"
}{
"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
taskId*string
Request Body
application/json
status?string
Value in
"pending" | "completed" | "cancelled"taskDueDate?|
Format
date-timetaskRecurrence?
expectedTaskDueDate?string
The currently displayed due date. Include this when completing a repeating task to make retries idempotent.
Format
date-time[key: string]?any
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://api.tiquo.app/api/v1/tasks/string" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"data": {
"id": "string",
"type": "note",
"title": "string",
"content": "string",
"categoryId": "string",
"categoryName": "string",
"locationId": "string",
"locationName": "string",
"isTask": true,
"taskDueDate": "2019-08-24T14:15:22Z",
"taskRecurrence": {
"frequency": "daily",
"customIntervalDays": 1
},
"taskRecurrenceCompletedCount": 0,
"taskStatus": "pending",
"taskCompletedAt": "2019-08-24T14:15:22Z",
"taskCompletedBy": "string",
"isPinned": true,
"isInternal": true,
"customerIds": [
"string"
],
"enquiryIds": [
"string"
],
"orderIds": [
"string"
],
"sublocationIds": [
"string"
],
"companyIds": [
"string"
],
"staffIds": [
"string"
],
"staffNames": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"createdByName": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedByName": "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"
}{
"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
taskId*string
Response Body
application/json
application/json
application/json
curl -X DELETE "https://api.tiquo.app/api/v1/tasks/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"
}Authorization
BearerAuth AuthorizationBearer <token>
API key from the Tiquo dashboard (Settings > Developer > Admin API)
In: header
Response Body
application/json
application/json
application/json
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"
}Authorization
BearerAuth AuthorizationBearer <token>
API key from the Tiquo dashboard (Settings > Developer > Admin API)
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/metadata/customer-parameters"{}{
"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
kind*string
Value in
"customers" | "companies" | "orders" | "bookings" | "enquiries" | "sublocations" | "services" | "task-categories" | "locations"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.tiquo.app/api/v1/metadata/options/customers"{
"success": true,
"data": {
"options": [
{
"id": "string",
"name": "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"
}{
"success": false,
"error": "string",
"timestamp": "2019-08-24T14:15:22Z"
}Response Format
All responses follow a consistent JSON structure:
{
"success": true,
"data": { ... },
"timestamp": "2025-01-15T10:30:00.000Z"
}Error responses include a descriptive message:
{
"success": false,
"error": "Customer not found with ID: CUST-999999",
"timestamp": "2025-01-15T10:30:00.000Z"
}Common Error Codes
| Status | Description |
|---|---|
400 | Bad request. Check your parameters. |
401 | Invalid or missing API key. |
403 | API key does not have permission for this operation. |
404 | The requested resource was not found. |
429 | Rate limit exceeded. Wait before retrying. |
500 | Internal server error. Contact support if this persists. |