Skip to main content
GET
/
v1
/
customers
/
{id}
Get Customer
curl --request GET \
  --url https://api.example.com/v1/customers/{id} \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": {},
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "dateOfBirth": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "loyaltyPoints": 123,
  "totalSpent": 123,
  "visitCount": 123,
  "tags": [
    {}
  ],
  "notes": "<string>",
  "preferredLocationId": "<string>",
  "marketingConsent": true,
  "companyId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "lastVisit": "<string>"
}

Get Customer

Retrieve detailed information about a specific customer.

Endpoint

GET /v1/customers/{id}

Authentication

Authorization
string
required
Bearer token with customers:read scope

Path Parameters

id
string
required
The customer ID (e.g., cust_abc123)

Request Example

curl -X GET "https://api.tiquo.co/v1/customers/cust_abc123" \
  -H "Authorization: Bearer sk_live_xxxxx"

Response

success
boolean
Whether the request succeeded
data
object
The customer object

Response Example

{
  "success": true,
  "data": {
    "id": "cust_abc123",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "dateOfBirth": "1990-05-15",
    "address": {
      "line1": "123 Main Street",
      "line2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "loyaltyPoints": 150,
    "totalSpent": 2500.00,
    "visitCount": 12,
    "tags": ["VIP", "frequent"],
    "notes": "Prefers morning appointments",
    "preferredLocationId": "loc_xyz789",
    "marketingConsent": true,
    "companyId": "comp_def456",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T14:00:00Z",
    "lastVisit": "2024-01-18T15:30:00Z"
  }
}

Full 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
dateOfBirth
string
Date of birth (YYYY-MM-DD)
address
object
Customer’s address
loyaltyPoints
integer
Current loyalty point balance
totalSpent
number
Total amount spent (in currency)
visitCount
integer
Number of visits/bookings
tags
array
Array of customer tags
notes
string
Internal notes about customer
preferredLocationId
string
Preferred location ID
Marketing email consent
companyId
string
Associated company ID (if B2B)
createdAt
string
ISO 8601 creation timestamp
updatedAt
string
ISO 8601 last update timestamp
lastVisit
string
ISO 8601 last visit timestamp

Errors

CodeDescription
401Invalid API key
403Missing customers:read scope
404Customer not found

404 Example

{
  "success": false,
  "error": {
    "code": "not_found",
    "message": "Customer not found"
  }
}

Code Examples

const customerId = 'cust_abc123';

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

const { data: customer } = await response.json();
console.log(customer.firstName, customer.lastName);