GET
/
customers
/
{id}
curl --request GET \
  --url https://api.kohortpay.com/customers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "cus_1234567890",
  "emailAddress": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1 555 555 5555",
  "livemode": true,
  "isBlocked": true,
  "organizationId": "org_1234567890",
  "addressId": "adr_1234567890",
  "shippingAddressId": "adr_1234567890",
  "metadata": {
    "my_system_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
  },
  "createdAt": "2021-07-22T00:00:00.000Z",
  "createdBy": "usr_1234567890",
  "updatedAt": "2021-07-22T00:00:00.000Z",
  "blockedAt": "2021-07-22T00:00:00.000Z",
  "blockedBy": "usr_1234567890",
  "updatedBy": "usr_1234567890",
  "deletedAt": "2021-07-22T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique customer ID

Query Parameters

​
expand
string[]

Fields to expand related entities. For example, ["organization"].

​
take
number

Maximum number of items to retrieve. Default is 25.

Example:

10

​
skip
number

Number of items to skip before starting to collect the result set.

Example:

0

​
orderBy
string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

Example:

"createdAt:desc"

​
search
string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Example:

"[email protected]"

Response

200 - application/json
Customer successfully retrieved.
​
id
string
required

The id of the customer.

Example:

"cus_1234567890"

​
emailAddress
string
required

The primary email address of the customer.

Example:

"[email protected]"

​
firstName
string | null
required

The first name of the customer.

Example:

"John"

​
lastName
string | null
required

The last name of the customer.

Example:

"Doe"

​
phoneNumber
string | null
required

The phone number of the customer.

Example:

"+1 555 555 5555"

​
livemode
boolean
required

Wether the customer is in live mode or test mode.

Example:

true

​
isBlocked
boolean
required

Wether the customer is blocked or not.

Example:

true

​
organizationId
string
required

The id of the organization.

Example:

"org_1234567890"

​
addressId
string | null
required

The id of the shippingAddress.

Example:

"adr_1234567890"

​
shippingAddressId
string | null
required

The id of the shippingAddress.

Example:

"adr_1234567890"

​
metadata
object | null
required

Additional metadata for the customer.

Example:
{
  "my_system_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
}
​
createdAt
string
required
Example:

"2021-07-22T00:00:00.000Z"

​
createdBy
string | null
required

The id of the user who created the customer.

Example:

"usr_1234567890"

​
updatedAt
string
required
Example:

"2021-07-22T00:00:00.000Z"

​
blockedAt
string | null
required
Example:

"2021-07-22T00:00:00.000Z"

​
blockedBy
string | null
required

The id of the user who blocked the customer.

Example:

"usr_1234567890"

​
updatedBy
string | null
required

The id of the user who last updated the customer.

Example:

"usr_1234567890"

​
deletedAt
string | null
required
Example:

"2021-07-22T00:00:00.000Z"