Customers
List customers
The List customers endpoint returns a list of customers for a given company's connection.
Customers are people or organizations that buy goods or services from the SMB.
Before using this endpoint, you must have retrieved data for the company.
get/companies/{companyId}/data/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
Success
Example response
{
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
}
}
}