Search for customers

curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
      "email": "[email protected]",
      "phone": "+14155552671",
      "statuses": {
        "Card Program Name": "OPEN"
      },
      "first_name": "John",
      "last_name": "Doe",
      "preferred_language": "en",
      "ssn4": "1234",
      "date_of_birth": {
        "year": 1990,
        "month": 1,
        "day": 1
      },
      "address": {
        "street_line1": "123 Main St",
        "street_line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "USA"
      },
      "partner_customer_id": "PARTNER_USER_456",
      "metadata": {
        "preferred_language": "en"
      },
      "created_at": "2025-02-13T19:08:07.000Z",
      "updated_at": "2025-02-13T19:08:07.000Z"
    }
  ],
  "has_more": true,
  "total": 123
}

GET

customers

curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
      "email": "[email protected]",
      "phone": "+14155552671",
      "statuses": {
        "Card Program Name": "OPEN"
      },
      "first_name": "John",
      "last_name": "Doe",
      "preferred_language": "en",
      "ssn4": "1234",
      "date_of_birth": {
        "year": 1990,
        "month": 1,
        "day": 1
      },
      "address": {
        "street_line1": "123 Main St",
        "street_line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "USA"
      },
      "partner_customer_id": "PARTNER_USER_456",
      "metadata": {
        "preferred_language": "en"
      },
      "created_at": "2025-02-13T19:08:07.000Z",
      "updated_at": "2025-02-13T19:08:07.000Z"
    }
  ],
  "has_more": true,
  "total": 123
}

Authorizations

Authorization

string

header

required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query Parameters

partner_customer_id

string

The unique identifier for the customer in the partner's system

limit

integer<int32>

default:10

Limits the number of returned results

Required range: x >= 1

starting_after

string

A cursor for use in pagination. An id that defines your place in the list.

Response

200 - application/json

List of customers

data

object[]

Show child attributes

data.id

string

required

Unique identifier for the customer

Example:

"9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4"

data.email

string<email>

Customer's email address

Example:

"[email protected]"

data.phone

string

Customer's phone number in E.164 format

Example:

"+14155552671"

data.statuses

object

Map of the customer's enrolled card program name to the customer's status.

Show child attributes

data.statuses.{key}

enum<string>

Status of a customer within a card program.

Available options:

OPEN,

CLOSED

Example:

{ "Card Program Name": "OPEN" }

data.first_name

string

The customer's first name.

Example:

"John"

data.last_name

string

The customer's last name.

Example:

"Doe"

data.preferred_language

string

Customer's preferred language code as defined by ISO 639-1

Example:

"en"

data.ssn4

string

Customer's Social Security Number in 4 digits

Example:

"1234"

data.date_of_birth

object

Customer's date of birth

Show child attributes

data.date_of_birth.year

integer

Year of birth

Required range: x >= 1900

Example:

1990

data.date_of_birth.month

integer

Month of birth

Required range: 1 <= x <= 12

Example:

1

data.date_of_birth.day

integer

Day of birth

Required range: 1 <= x <= 31

Example:

1

data.address

object

Mailing address information

Show child attributes

data.address.street_line1

string

Primary street address

Example:

"123 Main St"

data.address.street_line2

string

Secondary street address (apartment, suite, etc.)

Example:

"Apt 4B"

data.address.city

string

City name

Example:

"San Francisco"

data.address.state

string

State or province

Example:

"CA"

data.address.postal_code

string

ZIP or postal code

Example:

"94105"

data.address.country

string

ISO-3166-1 alpha-3 Country Code

Example:

"USA"

data.partner_customer_id

string

The unique identifier for the customer in the partner's system

Example:

"PARTNER_USER_456"

data.metadata

object

Set of key-value pairs for storing additional information about the customer.

Example:

{ "preferred_language": "en" }

data.created_at

string

the RFC-3339 date when the customer was created

Example:

"2025-02-13T19:08:07.000Z"

data.updated_at

string

the RFC-3339 date when the customer was created

Example:

"2025-02-13T19:08:07.000Z"

has_more

boolean

total

integer

API Key Rotation Search for customers

⌘I

Basics

API Reference

Search for customers

Authorizations

Query Parameters

Response