curl "https://sandbox.core.linkio.world/api/customers/list?page=1&limit=25" \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas"
{
"status": "success",
"message": "Customers retrieved",
"count": 1,
"pagination": { "page": 1, "limit": 25, "total": 1, "total_pages": 1, "has_more": false },
"customers": [
{
"id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"type": "retail",
"name": "Ada Obi",
"email": "ada@example.com",
"phone": "+2348012345678",
"address": null,
"country": null,
"metadata": {}
}
]
}
Customers
List customers
Get your customers, one page at a time, newest first.
GET
/
customers
/
list
curl "https://sandbox.core.linkio.world/api/customers/list?page=1&limit=25" \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas"
{
"status": "success",
"message": "Customers retrieved",
"count": 1,
"pagination": { "page": 1, "limit": 25, "total": 1, "total_pages": 1, "has_more": false },
"customers": [
{
"id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"type": "retail",
"name": "Ada Obi",
"email": "ada@example.com",
"phone": "+2348012345678",
"address": null,
"country": null,
"metadata": {}
}
]
}
Requires the Customers scope (read).
Headers
string
default:"2026-10-29-atlas"
required
Your account’s API version.
Query
integer
default:"1"
Which page to get. Starts at 1.
integer
default:"25"
How many per page. Up to 100.
Response
200 OK
string
successstring
Customers retrievedinteger
How many customers are on this page.
object
array
The customers. Each has the same fields as Add a customer.
Errors
| Status | Code | Why |
|---|---|---|
422 | validation_failed | page is below 1, or limit is above 100. |
curl "https://sandbox.core.linkio.world/api/customers/list?page=1&limit=25" \
-H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
-H "API-Version: 2026-10-29-atlas"
{
"status": "success",
"message": "Customers retrieved",
"count": 1,
"pagination": { "page": 1, "limit": 25, "total": 1, "total_pages": 1, "has_more": false },
"customers": [
{
"id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
"type": "retail",
"name": "Ada Obi",
"email": "ada@example.com",
"phone": "+2348012345678",
"address": null,
"country": null,
"metadata": {}
}
]
}
Last modified on October 29, 2026
Was this page helpful?