curl --request GET \
--url 'https://your-subdomain.unicyfalcon.com/api/v1/customers?per_page=25' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: your_api_key' \
--header 'X-Timestamp: 1735574400' \
--header 'X-Signature: generated_signature'
{
"success": true,
"data": [
{
"id": "9d3f4b2a-8c7e-4d1b-9f3a-5e6c7d8a9b0c",
"name": "John Doe",
"username": "johndoe",
"email": "john@example.com",
"phone": "555-1234",
"address": "123 Main St, New York, NY 10001",
"company_name": "Acme Corp",
"language": "en",
"timezone": "America/New_York",
"created_at": "2026-01-15T10:30:00Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"per_page": 25,
"to": 25,
"total": 73
},
"links": {
"first": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=1",
"last": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=3",
"prev": null,
"next": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=2"
}
}
Customers
List Customers
Retrieve a paginated list of all active customers
GET
/
api
/
v1
/
customers
curl --request GET \
--url 'https://your-subdomain.unicyfalcon.com/api/v1/customers?per_page=25' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: your_api_key' \
--header 'X-Timestamp: 1735574400' \
--header 'X-Signature: generated_signature'
{
"success": true,
"data": [
{
"id": "9d3f4b2a-8c7e-4d1b-9f3a-5e6c7d8a9b0c",
"name": "John Doe",
"username": "johndoe",
"email": "john@example.com",
"phone": "555-1234",
"address": "123 Main St, New York, NY 10001",
"company_name": "Acme Corp",
"language": "en",
"timezone": "America/New_York",
"created_at": "2026-01-15T10:30:00Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"per_page": 25,
"to": 25,
"total": 73
},
"links": {
"first": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=1",
"last": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=3",
"prev": null,
"next": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=2"
}
}
Query Parameters
Number of items per page (max: 100)
Page number to retrieve
Search in name, username, or email
Filter by language code (en, fr, es, etc.)
Response
Indicates if the request was successful
Array of customer objects
Show Customer Object
Show Customer Object
Unique customer identifier (UUID)
Customer’s full name
Customer’s username
Customer’s email address
Customer’s phone number
Customer’s address
Customer’s company name
Customer’s preferred language
Customer’s timezone
ISO 8601 timestamp
curl --request GET \
--url 'https://your-subdomain.unicyfalcon.com/api/v1/customers?per_page=25' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: your_api_key' \
--header 'X-Timestamp: 1735574400' \
--header 'X-Signature: generated_signature'
{
"success": true,
"data": [
{
"id": "9d3f4b2a-8c7e-4d1b-9f3a-5e6c7d8a9b0c",
"name": "John Doe",
"username": "johndoe",
"email": "john@example.com",
"phone": "555-1234",
"address": "123 Main St, New York, NY 10001",
"company_name": "Acme Corp",
"language": "en",
"timezone": "America/New_York",
"created_at": "2026-01-15T10:30:00Z"
}
],
"meta": {
"current_page": 1,
"from": 1,
"last_page": 3,
"per_page": 25,
"to": 25,
"total": 73
},
"links": {
"first": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=1",
"last": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=3",
"prev": null,
"next": "https://your-subdomain.unicyfalcon.com/api/v1/customers?page=2"
}
}
⌘I
