List customers
Fetching a list of customers.
List
Return a collection of customers.
Filtering
List of customers for specific email(s)
/customers?filter[email][email protected]/customers?filter[email][email protected],[email protected]
List of customers for specific external identifier(s)
/customers?filter[external_identifier]=12345/customers?filter[external_identifier]=12345,67890
See: Pagination, Filtering
This collection is cursor paginated: links.first/links.last are null, links.next/links.prev
carry the cursor URLs and meta contains next_cursor/prev_cursor instead of current_page.
AuthorizationbearerAuth
Authorization
bearerAuth API token as bearer token — you receive a test and a live token, there is no switch between them. See Setup → Authentication and Setup → Test mode.
In: header
Query Parameters
Cursor of the page to return — take it from meta.next_cursor / meta.prev_cursor or follow links.next / links.prev of the previous response.
Number of objects per page (default 25, maximum 100) — see Basic Usage → Pagination.
value <= 10025List of customers for specific email(s). Several values are separated by comma, e.g. filter[email][email protected],[email protected].
List of customers for specific external identifier(s). Several values are separated by comma, e.g. filter[external_identifier]=12345,67890.
Header Parameters
The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).
"application/json"Value in
- "application/json"
Response Body
application/json
application/json
curl -X GET "https://example.com/customers?cursor=eyJjdXN0b21lcnMuaWQiOjEyLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9&filter%5Bemail%5D=test%40test.com&filter%5Bexternal_identifier%5D=12345" \ -H "Accept: application/json"{ "data": [ { "id": 14, "first_name": "Delta", "last_name": "Spencer", "is_test": 0, "email": "[email protected]", "external_identifier": null, "created_at": "2026-03-02T08:31:06+00:00", "updated_at": "2026-03-02T08:31:06+00:00" }, { "id": 13, "first_name": "America", "last_name": "Gleason", "is_test": 0, "email": "[email protected]", "external_identifier": null, "created_at": "2026-03-02T08:31:06+00:00", "updated_at": "2026-03-02T08:31:06+00:00" }, { "id": 12, "first_name": "Remington", "last_name": "Hessel", "is_test": 0, "email": "[email protected]", "external_identifier": null, "created_at": "2026-03-02T08:31:06+00:00", "updated_at": "2026-03-02T08:31:06+00:00" } ], "links": { "first": null, "last": null, "prev": null, "next": "https://api.smake.io/v2/apps/1/customers?cursor=eyJjdXN0b21lcnMuaWQiOjEyLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9" }, "meta": { "path": "https://api.smake.io/v2/apps/1/customers", "per_page": 15, "next_cursor": "eyJjdXN0b21lcnMuaWQiOjEyLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9", "prev_cursor": null }}