Skip to main content
GET
/
v1
/
customers
Retrieve a customer
curl --request GET \
  --url https://api.creem.io/v1/customers \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "mode": "test",
  "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"
}

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

ā€‹
customer_id
string

The unique identifier of the customer

ā€‹
email
string

The unique email of the customer

Response

Successfully retrieved the customer

ā€‹
id
string
required

Unique identifier for the object.

ā€‹
mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
ā€‹
object
string
required

String representing the objectā€™s type. Objects of the same type share the same value.

ā€‹
email
string
required

Customer email address.

Example:

"user@example.com"

ā€‹
country
string
required

The ISO alpha-2 country code for the customer.

Example:

"US"

ā€‹
created_at
string<date-time>
required

Creation date of the product

Example:

"2023-01-01T00:00:00Z"

ā€‹
updated_at
string<date-time>
required

Last updated date of the product

Example:

"2023-01-01T00:00:00Z"

ā€‹
name
string

Customer name.

Example:

"John Doe"