Sign in
ecommerce/customers

List Customers

get/ecommerce/customers

Query parameters

remote_databoolean

Set to true to include data from the original software.

limitnumber

Set to get the number of records.

cursorstring

Set to get the number of records after this cursor.

Headers

x-connection-tokenstring required

The connection token

Response

prev_cursorstring nullable required
next_cursorstring nullable required

Example response

{
  "data": [
    {
      "email": "joedoe@gmail.com",
      "first_name": "Joe",
      "last_name": "Doe",
      "phone_number": "+336666666",
      "addresses": [
        {
          "address_type": "PERSONAL",
          "street_1": "5th Avenue",
          "state": "New York",
          "city": "New York",
          "country": "United States of America"
        }
      ],
      "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "id_1",
      "remote_data": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "created_at": "2024-10-01T12:00:00Z",
      "modified_at": "2024-10-01T12:00:00Z"
    }
  ]
}

Changes

Changed in 6 of the 18 revisions of this API.1411

  • ef360d76c6581See the full diff
    • ▲

      for the query request parameter limit, default value 50 was removed

      request-parameter-default-value-removed

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • be3dc330edf32See the full diff
    • ○

      removed the PERSONAL enum value from the allOf[subschema #2]/data/items/addresses/items/address_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the WORK enum value from the allOf[subschema #2]/data/items/addresses/items/address_type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 17251bf7794f1See the full diff
    • ▲

      for the query request parameter limit, default value 50 was added

      request-parameter-default-value-added

  • 3539cfe8509c1See the full diff
    • ▲

      for the query request parameter limit, default value 30 was removed

      request-parameter-default-value-removed

  • 87189baf7791118See the full diff
    • ▲

      the response property allOf[subschema #2]/data/items/addresses became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/created_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/email became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/field_mappings became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/first_name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/last_name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/modified_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/phone_number became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/remote_data became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/remote_id became nullable for the status 200

      response-property-became-nullable

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/address_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/city to the response with the 200 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/country to the response with the 200 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/owner_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/postal_code to the response with the 200 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/state to the response with the 200 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/street_1 to the response with the 200 status

      response-required-property-added

    • ○

      added the required property allOf[subschema #2]/data/items/addresses/items/street_2 to the response with the 200 status

      response-required-property-added

  • 3ce49f5aad531See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog