Tiquo
Admin API

Admin API

Server-side API for managing your organization data

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/v1

Authentication

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.

Admin API settings page

Permissions

Each key has a set of read and write permissions per resource, such as customers.read and customers.write. GET endpoints need the resource's read permission, and POST, PATCH, and DELETE endpoints need its write permission. A write permission does not include read, so a key that both creates and looks up customers needs customers.read and customers.write. A request without the permission it needs returns 403 with "API key does not have permission for this operation".

Browser requests

The Admin API is intended for server-side integrations. Browser CORS is limited to https://docs.tiquo.co, https://tiquo.app, and https://www.tiquo.app so the documentation testers can call it. API-key permissions and any origin or IP restrictions still apply.

The current preflight response allows GET, POST, and PATCH, but does not allow DELETE. Use a server-side client or curl for DELETE operations; the browser tester cannot execute them.

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

ResourceEndpointsStatus
CustomersGET /customers, POST /customers, GET /customers/{customerId}, PATCH /customers/{customerId}, GET /customers/{customerId}/store-credit, POST /customers/{customerId}/store-creditAvailable
CompaniesGET /companies, POST /companies, GET /companies/{companyId}, PATCH /companies/{companyId}, POST /companies/{companyId}/store-creditAvailable
OrdersGET /orders, POST /orders, GET /orders/{orderId}, PATCH /orders/{orderId}, DELETE /orders/{orderId}Available
BookingsGET /bookings, POST /bookings, GET /bookings/{bookingId}, PATCH /bookings/{bookingId}, DELETE /bookings/{bookingId}, GET /bookings/{bookingId}/ticketAvailable
EnquiriesGET /enquiries, POST /enquiries, GET /enquiries/{enquiryId}, PATCH /enquiries/{enquiryId}, DELETE /enquiries/{enquiryId}Available
TasksGET /tasks, POST /tasks, GET /tasks/{taskId}, PATCH /tasks/{taskId}, DELETE /tasks/{taskId}Available
MetadataGET /metadata/enquiries, GET /metadata/customer-parameters, GET /metadata/options/{kind}Available
Account and webhook subscriptionsGET /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, PATCH, and DELETE operations change organization data. Browser DELETE requests are currently blocked by CORS; use a server-side client or curl. Your API key is stored only in this browser's local storage, so use the tester on a trusted device.

GET
/account

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"
}
POST
/zapier/subscriptions

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<>
Items1 <= items
targetUrl?string

Unique HTTPS callback URL issued by hooks.zapier.com.

Formaturi
[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"
}
DELETE
/zapier/subscriptions/{subscriptionId}

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"
}
GET
/customers

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer
Default50
Range1 <= value <= 100
cursor?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",
      "title": "mr",
      "customTitle": "string",
      "nickname": "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"
}
POST
/customers

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

parameters?

Customer parameter updates keyed by system ID, custom schema ID, name, or normalized name. Requires customers.write and staff-editable parameters. Submitted values replace existing values; omitted or null values are unchanged. Use an empty string or empty array to clear optional values. Select/multiselect values must match active configured options. Compound values use a JSON string. Consent accepts true/false and records the opt-in date automatically. Invalid values or inaccessible schemas reject the entire customer write with HTTP 400.

firstName?string
lastName?string
displayName?string
title?|

A title code (mr, mrs, ms, miss, mx, dr, prof; "Mr." also works) or any other text, which is stored as a custom title. An empty string or null clears the title.

customTitle?|

Custom title text, used with title "other".

nickname?|

Empty string or null clears.

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
Formaturi

Response 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",
    "title": "mr",
    "customTitle": "string",
    "nickname": "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"
}
GET
/customers/{customerId}

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",
    "title": "mr",
    "customTitle": "string",
    "nickname": "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"
}
PATCH
/customers/{customerId}

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

parameters?

Customer parameter updates keyed by system ID, custom schema ID, name, or normalized name. Requires customers.write and staff-editable parameters. Submitted values replace existing values; omitted or null values are unchanged. Use an empty string or empty array to clear optional values. Select/multiselect values must match active configured options. Compound values use a JSON string. Consent accepts true/false and records the opt-in date automatically. Invalid values or inaccessible schemas reject the entire customer write with HTTP 400.

firstName?string
lastName?string
displayName?string
title?|

A title code (mr, mrs, ms, miss, mx, dr, prof; "Mr." also works) or any other text, which is stored as a custom title. An empty string or null clears the title.

customTitle?|

Custom title text, used with title "other".

nickname?|

Empty string or null clears.

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",
    "title": "mr",
    "customTitle": "string",
    "nickname": "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"
}
GET
/customers/{customerId}/store-credit

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}$
Length3 <= length <= 3

Response 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"
}
POST
/customers/{customerId}/store-credit

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._:-]+$
Length1 <= length <= 128

Request Body

application/json

amount*number

Positive amount to add to the balance.

Multiple Of0.01
Range0 < value <= 1000000
currency*string
Match^[A-Za-z]{3}$
Length3 <= length <= 3
note?string

Optional note for the ledger entry.

Lengthlength <= 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"
}
GET
/companies

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer
Default50
Range1 <= value <= 100
status?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"
}
POST
/companies

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
Formatemail
phone?string
website?string
Formaturi
websites?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"
}
GET
/companies/{companyId}

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"
}
PATCH
/companies/{companyId}

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
Formatemail
phone?string
website?string
Formaturi
websites?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"
}
POST
/companies/{companyId}/store-credit

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._:-]+$
Length1 <= length <= 128

Request Body

application/json

amount*number

Positive amount to add to the balance.

Multiple Of0.01
Range0 < value <= 1000000
currency*string
Match^[A-Za-z]{3}$
Length3 <= length <= 3
note?string

Optional note for the ledger entry.

Lengthlength <= 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"
}
GET
/orders

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer
Default50
Range1 <= value <= 100
cursor?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
Formatemail
dateFrom?string

Filter by order createdAt, inclusive

Formatdate
dateTo?string
Formatdate
source?string
serviceId?string
sublocationId?string
customerId?string
attendeeCountMin?integer
Range0 <= value
attendeeCountMax?integer

Filter by order createdAt, inclusive

Range0 <= value
updatedAfter?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.

Formatdate-time
amountMin?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"
}
POST
/orders

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<>
Items1 <= items

Response Body

application/json

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": "line_1",
        "type": "product",
        "name": "House Red",
        "quantity": 2,
        "unitPrice": 9.5,
        "subtotal": 19,
        "tax": 3.17,
        "taxRate": 20,
        "discount": 0,
        "total": 19,
        "sku": "HOUSE-RED",
        "productId": "k57a2b9x8c4d6e0f1g2h3j4k5m6n7p8q",
        "categoryName": "Wine / Red Wine",
        "reportingCategory": "Wine / Red Wine",
        "variant": {
          "id": "k97b3c0y9d5e7f1g2h3j4k5m6n7p8q9r",
          "name": "175ml"
        },
        "variants": [
          {
            "id": "k97b3c0y9d5e7f1g2h3j4k5m6n7p8q9r",
            "name": "175ml"
          }
        ],
        "category": {
          "id": "k17c4d1z0e6f8g2h3j4k5m6n7p8q9r0s",
          "name": "Wine"
        },
        "subcategory": {
          "id": "k27d5e2a1f7g9h3j4k5m6n7p8q9r0s1t",
          "name": "Red Wine"
        },
        "categoryPath": [
          {
            "id": "k17c4d1z0e6f8g2h3j4k5m6n7p8q9r0s",
            "name": "Wine"
          },
          {
            "id": "k27d5e2a1f7g9h3j4k5m6n7p8q9r0s1t",
            "name": "Red Wine"
          }
        ],
        "productStatus": "delivered"
      }
    ],
    "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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/orders/{orderId}

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": "line_1",
        "type": "product",
        "name": "House Red",
        "quantity": 2,
        "unitPrice": 9.5,
        "subtotal": 19,
        "tax": 3.17,
        "taxRate": 20,
        "discount": 0,
        "total": 19,
        "sku": "HOUSE-RED",
        "productId": "k57a2b9x8c4d6e0f1g2h3j4k5m6n7p8q",
        "categoryName": "Wine / Red Wine",
        "reportingCategory": "Wine / Red Wine",
        "variant": {
          "id": "k97b3c0y9d5e7f1g2h3j4k5m6n7p8q9r",
          "name": "175ml"
        },
        "variants": [
          {
            "id": "k97b3c0y9d5e7f1g2h3j4k5m6n7p8q9r",
            "name": "175ml"
          }
        ],
        "category": {
          "id": "k17c4d1z0e6f8g2h3j4k5m6n7p8q9r0s",
          "name": "Wine"
        },
        "subcategory": {
          "id": "k27d5e2a1f7g9h3j4k5m6n7p8q9r0s1t",
          "name": "Red Wine"
        },
        "categoryPath": [
          {
            "id": "k17c4d1z0e6f8g2h3j4k5m6n7p8q9r0s",
            "name": "Wine"
          },
          {
            "id": "k27d5e2a1f7g9h3j4k5m6n7p8q9r0s1t",
            "name": "Red Wine"
          }
        ],
        "productStatus": "delivered"
      }
    ],
    "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"
}
PATCH
/orders/{orderId}

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

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": "line_1",
        "type": "product",
        "name": "House Red",
        "quantity": 2,
        "unitPrice": 9.5,
        "subtotal": 19,
        "tax": 3.17,
        "taxRate": 20,
        "discount": 0,
        "total": 19,
        "sku": "HOUSE-RED",
        "productId": "k57a2b9x8c4d6e0f1g2h3j4k5m6n7p8q",
        "categoryName": "Wine / Red Wine",
        "reportingCategory": "Wine / Red Wine",
        "variant": {
          "id": "k97b3c0y9d5e7f1g2h3j4k5m6n7p8q9r",
          "name": "175ml"
        },
        "variants": [
          {
            "id": "k97b3c0y9d5e7f1g2h3j4k5m6n7p8q9r",
            "name": "175ml"
          }
        ],
        "category": {
          "id": "k17c4d1z0e6f8g2h3j4k5m6n7p8q9r0s",
          "name": "Wine"
        },
        "subcategory": {
          "id": "k27d5e2a1f7g9h3j4k5m6n7p8q9r0s1t",
          "name": "Red Wine"
        },
        "categoryPath": [
          {
            "id": "k17c4d1z0e6f8g2h3j4k5m6n7p8q9r0s",
            "name": "Wine"
          },
          {
            "id": "k27d5e2a1f7g9h3j4k5m6n7p8q9r0s1t",
            "name": "Red Wine"
          }
        ],
        "productStatus": "delivered"
      }
    ],
    "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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
DELETE
/orders/{orderId}

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

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/bookings

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
type?string
status?string
priority?string
Value in"low" | "medium" | "high" | "urgent"
source?string
category?string
email?string
Formatemail
customerId?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
Formatdate
dateTo?string
Formatdate

Response 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"
}
POST
/bookings

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
Range0 < value
nights?integer
Range1 <= value
timezone?string
attendeeCount?integer
Range1 <= value
adults?integer
Range0 <= value
children?integer
Range0 <= value
amount?number
Range0 <= value
source?string
Default"admin"
customerNotes?string
status?string
Default"scheduled"
Value in"scheduled"

Response Body

application/json

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/bookings/{bookingId}

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"
}
PATCH
/bookings/{bookingId}

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

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
DELETE
/bookings/{bookingId}

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

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/bookings/{bookingId}/ticket

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"
}
GET
/enquiries

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

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"
}
POST
/enquiries

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

application/json

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/enquiries/{enquiryId}

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"
}
PATCH
/enquiries/{enquiryId}

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

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
DELETE
/enquiries/{enquiryId}

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

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/tasks

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

limit?integer
Default50
Range1 <= value <= 100

Response 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"
}
POST
/tasks

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
Formatdate-time
taskRecurrence?
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

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/tasks/{taskId}

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"
}
PATCH
/tasks/{taskId}

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?|
Formatdate-time
taskRecurrence?
expectedTaskDueDate?string

The currently displayed due date. Include this when completing a repeating task to make retries idempotent.

Formatdate-time
[key: string]?any

Response Body

application/json

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
DELETE
/tasks/{taskId}

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

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"
}
{
  "success": false,
  "error": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
GET
/metadata/enquiries

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"
}
GET
/metadata/customer-parameters

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"
}
GET
/metadata/options/{kind}

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

StatusDescription
400Bad request: invalid JSON, a missing or invalid field, or a change Tiquo refuses, such as a status change that isn't allowed.
401Invalid or missing API key.
403The API key does not have permission for this operation, or the request is outside the key's origin or IP restrictions.
404The requested resource was not found.
409Conflict with existing data, such as a duplicate customer email or phone number, a company domain already used by another company, or a reused Idempotency-Key.
429Rate limit exceeded. Wait before retrying.
500Internal server error. Retry later, and contact support if it persists.

Other than 429, a 4xx response means Tiquo refused the request, and its error message says what to change. Don't retry it unchanged. A 500 means the request failed on Tiquo's side; its message is a generic "Internal server error" and doesn't describe your input, so retry with backoff.

API Authentication

How authentication works across the Tiquo APIs

List Customers

Retrieve a paginated list of customers with optional filters including parameter-based filtering