Get Customer

Retrieve a customer record using any of the supported identifier formats.

Endpoint

GET /customers/{customerId}

Authentication

Requires a valid Admin API key.

Authorization: Bearer your_api_key_here

Test the API

Enter your Admin API key and a customer identifier, then select Send. The request is sent directly from your browser to the live Admin API.

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`

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"
}

Path parameters

Parameter	Type	Required	Description
`customerId`	string	Yes	A customer identifier. Accepts multiple formats (see below).

Supported identifier formats

You can look up customers using any of these formats:

Format	Example	Description
Customer number	`CUST-000001`	The human-readable customer ID assigned by Tiquo
Email address	`john@example.com`	The customer's primary email
Phone number	`+15554567890`	The customer's phone number (multiple formats supported)
Document ID	`k1234567890abcdef`	The internal Tiquo document ID

Phone number format support

The API normalizes phone numbers automatically, so you can pass them in any common format:

International: +1 (555) 456-7890 or +15554567890
Double zero prefix: 00 1 555 456 7890 or 0015554567890
No prefix: 1 555 456 7890 or 15554567890

Spaces, dashes, parentheses, and dots are all handled automatically.

Example request

curl -X GET "https://api.tiquo.app/api/v1/customers/CUST-000001" \
  -H "Authorization: Bearer your_api_key_here"

Response

{
  "success": true,
  "data": {
    "id": "k1234567890abcdef",
    "customerNumber": "CUST-000001",
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "John Doe",
    "title": "mr",
    "nickname": "Johnny",
    "emails": [
      { "address": "john@example.com", "isPrimary": true }
    ],
    "phones": [
      { "number": "+15554567890", "isPrimary": true }
    ],
    "profilePhoto": "https://example.com/photo.jpg",
    "status": "active",
    "source": "website",
    "marketingOptIn": true,
    "smsOptIn": false,
    "totalOrders": 15,
    "totalSpent": 2450.50,
    "averageOrderValue": 163.37,
    "lastOrderDate": 1640995200000,
    "lastActivityDate": 1640995200000,
    "lifetimeValue": 2450.50,
    "createdAt": 1640995200000,
    "updatedAt": 1640995200000
  },
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Customer object

Field	Type	Description
`id`	string	Internal document ID
`customerNumber`	string	Human-readable customer ID (e.g. `CUST-000001`)
`firstName`	string or null	Customer's first name
`lastName`	string or null	Customer's last name
`displayName`	string or null	Full display name
`title`	string or null	Title code: `mr`, `mrs`, `ms`, `miss`, `mx`, `dr`, `prof`, or `other`
`customTitle`	string or null	The title text when `title` is `other`
`nickname`	string or null	The name the customer likes to be called
`emails`	array	List of email objects with `address` (string) and `isPrimary` (boolean)
`phones`	array	List of phone objects with `number` (string) and `isPrimary` (boolean)
`profilePhoto`	string or null	URL to the customer's profile photo
`status`	string	One of: `active`, `inactive`, `banned`
`source`	string or null	How the customer was acquired (e.g. `website`, `admin`)
`parameters`	array	Saved values with `id`, `parameterId`, `value`, and `lastModified`; use `parameterId` as the schema key
`marketingOptIn`	boolean	Whether the customer has opted in to email marketing
`smsOptIn`	boolean	Whether the customer has opted in to messaging communications delivered through SMS or WhatsApp, using their preferred messaging channel
`totalOrders`	integer or null	Total number of orders placed
`totalSpent`	number or null	Total amount spent in the customer's currency
`averageOrderValue`	number or null	Average value per order
`lastOrderDate`	integer or null	Unix timestamp in milliseconds of the last order
`lastActivityDate`	integer or null	Unix timestamp in milliseconds of the last activity
`lifetimeValue`	number or null	Customer lifetime value
`createdAt`	integer	Unix timestamp in milliseconds when the record was created
`updatedAt`	integer	Unix timestamp in milliseconds of the last update

marketingOptIn and smsOptIn are read-only response summaries. To edit them, use the parameters object on Update Customer. The saved value row's id is not the parameter schema ID; write using parameterId.

Error responses

400 Bad Request

{
  "success": false,
  "error": "Invalid customer identifier format",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

401 Unauthorized

{
  "success": false,
  "error": "Missing or invalid API key",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

404 Not Found

{
  "success": false,
  "error": "Customer not found with ID: CUST-999999",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

429 Too Many Requests

{
  "success": false,
  "error": "Rate limit exceeded. Please retry after the current window resets.",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Code examples

JavaScript

const response = await fetch(
  'https://api.tiquo.app/api/v1/customers/CUST-000001',
  {
    headers: {
      'Authorization': `Bearer ${apiKey}`,
    },
  }
);

const data = await response.json();

if (data.success) {
  console.log(data.data.displayName);
  const primaryEmail = data.data.emails.find(e => e.isPrimary)?.address;
  console.log(primaryEmail);
} else {
  console.error(data.error);
}

Python

import requests

response = requests.get(
    'https://api.tiquo.app/api/v1/customers/CUST-000001',
    headers={'Authorization': f'Bearer {api_key}'}
)

data = response.json()

if data['success']:
    customer = data['data']
    print(customer['displayName'])
else:
    print(data['error'])

Looking up by email

curl -X GET "https://api.tiquo.app/api/v1/customers/john@example.com" \
  -H "Authorization: Bearer your_api_key_here"

Looking up by phone

curl -X GET "https://api.tiquo.app/api/v1/customers/+15554567890" \
  -H "Authorization: Bearer your_api_key_here"

Get Customer

200application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`