Skip to main content
GET
/
v1
/
customers
List Customers
curl --request GET \
  --url https://api.example.com/v1/customers \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": [
    {}
  ],
  "pagination": {},
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "loyaltyPoints": 123,
  "tags": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

​
List Customers

Retrieve a paginated list of customers.

​
Endpoint

GET /v1/customers

​
Authentication

​
Authorization
string
required
Bearer token with customers:read scope

​
Query Parameters

​
limit
integer
default:"25"
Number of customers to return (1-100)
​
cursor
string
Pagination cursor from previous response
​
email
string
Filter by email address
​
search
string
Search by name or email
​
createdAfter
string
ISO 8601 datetime - customers created after
​
createdBefore
string
ISO 8601 datetime - customers created before

​
Request Example

curl -X GET "https://api.tiquo.co/v1/customers?limit=10" \
  -H "Authorization: Bearer sk_live_xxxxx"

​
Response

​
success
boolean
Whether the request succeeded
​
data
array
Array of customer objects
​
pagination
object
Pagination information

​
Response Example

{
  "success": true,
  "data": [
    {
      "id": "cust_abc123",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "phone": "+1234567890",
      "loyaltyPoints": 150,
      "tags": ["VIP", "frequent"],
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-20T14:00:00Z"
    },
    {
      "id": "cust_def456",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": "+0987654321",
      "loyaltyPoints": 75,
      "tags": [],
      "createdAt": "2024-01-16T09:00:00Z",
      "updatedAt": "2024-01-16T09:00:00Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "cust_def456"
  }
}

​
Customer Object

​
id
string
Unique customer identifier
​
firstName
string
Customer’s first name
​
lastName
string
Customer’s last name
​
email
string
Customer’s email address
​
phone
string
Customer’s phone number
​
loyaltyPoints
integer
Current loyalty point balance
​
tags
array
Array of customer tags
​
createdAt
string
ISO 8601 creation timestamp
​
updatedAt
string
ISO 8601 last update timestamp

​
Pagination

Use cursor-based pagination for large datasets: 
# First page
GET /v1/customers?limit=25

# Next page
GET /v1/customers?limit=25&cursor=cust_def456

​
Errors

CodeDescription
401Invalid API key
403Missing customers:read scope
429Rate limit exceeded

​
Code Examples

const response = await fetch('https://api.tiquo.co/v1/customers?limit=10', {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
});

const { data, pagination } = await response.json();

Get Customer

Retrieve single customer

Create Customer

Create new customer