accounting/accounts3

accounting/addresses2

accounting/attachments3

accounting/balancesheets2

accounting/cashflowstatements2

accounting/companyinfos2

accounting/contacts3

accounting/creditnotes2

accounting/expenses3

accounting/incomestatements2

accounting/invoices3

accounting/items2

accounting/journalentries3

accounting/payments3

accounting/phonenumbers2

accounting/purchaseorders3

accounting/taxrates2

accounting/trackingcategories2

accounting/transactions2

accounting/vendorcredits2

auth1

connections1

crm/companies3

crm/contacts3

crm/deals3

crm/engagements3

crm/notes3

crm/stages2

crm/tasks3

crm/users2

ecommerce/customers2

ecommerce/fulfillments2

ecommerce/orders3

ecommerce/products3

events1

fieldMappings6

filestorage/files3

filestorage/folders3

filestorage/groups2

filestorage/users2

linkedUsers5

marketingautomation/actions3

marketingautomation/automations3

marketingautomation/campaigns3

marketingautomation/contacts3

marketingautomation/emails2

marketingautomation/events2

marketingautomation/lists3

marketingautomation/messages2

marketingautomation/templates3

marketingautomation/users2

passthrough2

projects2

sync4

ticketing/accounts2

ticketing/attachments3

ticketing/collections2

ticketing/comments3

ticketing/contacts2

ticketing/tags2

ticketing/teams2

ticketing/tickets3

ticketing/users2

webhooks5

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

Nov 18, 2024ef360d76c6581See 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
Sep 20, 2024be3dc330edf32See the full diff
- ○
  removed the PERSONAL enum value from the ///// response property for the response status
  response-property-enum-value-removed
- ○
  removed the WORK enum value from the ///// response property for the response status
  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
Aug 14, 202417251bf7794f1See the full diff
- ▲
  for the query request parameter limit, default value 50 was added
  request-parameter-default-value-added
Aug 9, 20243539cfe8509c1See the full diff
- ▲
  for the query request parameter limit, default value 30 was removed
  request-parameter-default-value-removed
Aug 7, 202487189baf7791118See the full diff
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
- ○
  added the required property ///// to the response with the status
  response-required-property-added
Aug 7, 20243ce49f5aad531See 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

Full history