Skip to main content
GET
/
v1
/
customers
/
list
List all customers
curl --request GET \
  --url https://api.creem.io/v1/customers/list \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "object": "<string>",
      "email": "user@example.com",
      "country": "US",
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "name": "John Doe",
      "metadata": {
        "key": "value"
      }
    }
  ],
  "pagination": {
    "total_records": 0,
    "total_pages": 0,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.creem.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Query Parameters

​
page_number
number
default:1

The page number for pagination.

Example:

1

​
page_size
number
default:50

The number of items per page.

Example:

50

Response

Successfully retrieved customers

​
items
object[]
required

List of customer items

​
pagination
object
required

Pagination details for the list