latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-042131317.4 KB

c56aa8f7d9f2

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

OK

Customers required— unresolved $ref