Customers
List all customers
Changed onRetrieve a paginated list of all customers. Filter and search through your customer base.
get/v1/customers/list
Request
- Base URLhttps://api.creem.io
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
page_numbernumber
Example:1
The page number for pagination.
page_sizenumber
Example:50
The number of items per page.
Response
Successfully retrieved customers
Example response
{
"items": [
{
"email": "user@example.com",
"name": "John Doe",
"metadata": {
"key": "value"
},
"country": "US",
"external_id": "user-42",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
}
],
"pagination": {
"current_page": 1,
"next_page": 2
}
}Changes
- breaking
the
//response's property type changed fromobjecttostringfor status
- breaking
- info
added the optional property
//to the response with the status
- info