Skip to main content
Version: 202506

List customers

GET 
/openapi/2025-06/customers

Retrieve a list of all customers with pagination.

Request​

Query Parameters

    cursor string

    The cursor for pagination

    page_size int32

    The number of customers to retrieve per page. The default is 10, and the maximum is 250

    ids string[]

    A list of customer IDs. Example: ?ids=1001&ids=1002

    created_at_min string

    Retrieve customers created after this date. It's in UTC (0 timezone), formatted as ISO-8601

    created_at_max string

    Retrieve customers created before this date. It's in UTC (0 timezone), formatted as ISO-8601

    updated_at_min string

    Retrieve customers last updated after this date. It's in UTC (0 timezone), formatted as ISO-8601

    updated_at_max string

    Retrieve customers last updated before this date. It's in UTC (0 timezone), formatted as ISO-8601

    email string

    Filter customers by email

    contact string

    Filter customers by contact information (email or phone)

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    customers object[]

    List of customers

  • Array [
    • idstring

    Customer ID

    emailstring

    Customer's email address

    created_atstring

    Timestamp when the customer was created, in ISO8601 format

    updated_atstring

    Timestamp when the customer was last updated, in ISO8601 format

    first_namestring

    Customer's first name

    last_namestring

    Customer's last name

    phonestring

    Customer's phone number

    tagsstring[]

    Tags associated with the customer

    namestring

    Full name of the customer

    phone_area_codestring

    Area code of the phone number

    contact_typestring

    Contact type, either email or phone

    sms_subscribed_flagint32

    Customer's SMS subscription status flag

    addresses object[]

    List of all customer addresses

  • Array [
    • idstring

    Address ID

    customer_idstring

    ID of the customer this address belongs to

    first_namestring

    First name of the consignee

    last_namestring

    Last name of the consignee

    companystring

    Company name

    citystring

    City of the address

    provincestring

    Province or state of the address

    countrystring

    Country name of the address

    zipstring

    Postal or ZIP code

    province_codestring

    Province code

    country_codestring

    ISO country code

    genderstring

    Gender of the consignee

    phonestring

    Phone number associated with the address

    phone_area_codestring

    Area code of the phone number

    areastring

    Area or region of the address

    emailstring

    Email associated with the address

    namestring

    Full name of the consignee

    address1string

    Primary street address

    address2string

    Secondary street address

    country_namestring

    Full name of the country

    defaultboolean

    Indicates if this is the default address

  • ]
    • accepts_marketingboolean

    Indicates if the customer is subscribed to marketing emails

    sourcestring

    Source of the customer data

    free_taxboolean

    Indicates if the customer is exempt from taxes

    registeredboolean

    Indicates if the customer is registered

    orders_countint32

    Number of orders placed by the customer

    first_order_atstring

    First order timestamp

    last_order_atstring

    Timestamp of the customer's last order

    total_spentstring

    Total amount spent by the customer

    subscribed_flagint32

    Customer's marketing subscription status flag

    accepts_sms_marketingboolean

    Indicates if the customer is subscribed to SMS marketing campaigns

  • ]
    • cursorstring

    The cursor for the next page of results

    has_moreboolean

    Whether there are more records