Customers

List customers

The List customers endpoint returns a list of customers for a given company's connection.

Customers are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/connections/{connectionId}/data/commerce-customers

Query parameters

pageinteger

Example:1

Page number. Read more.

pageSizeinteger

Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring

Example:-modifiedDate

Field to order results by. Read more.

Response

Customers required— unresolved $ref

Changes

Changed in 8 of the 53 revisions of this API.1221

Feb 13, 20248ba9a6a9b56a9See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Oct 23, 2023638d28ff67734See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Jul 6, 2023f5898440c7ad2See the full diff
- ●
  removed the optional property ////// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
Jul 4, 2023494a393d5cec2See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
May 31, 2023da0aba4733ac1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 25, 2023be0826c6d38f4See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
May 19, 2023753db470ad5a1See the full diff
- ○
  the query request parameter page became optional
  request-parameter-became-optional
May 10, 2023e37fd02554a41See the full diff
- ▲
  for the query request parameter page, the min was increased from 0.00 to 1.00
  request-parameter-min-increased

Full history