Sign in
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

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required— unresolved $ref

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"
    }
  }
}

Changes

Changed in 2 of the 51 revisions of this API.19

  • c72dd261b9b41See the full diff
    • ▲

      the response property allOf[subschema #1]/results/items/allOf[subschema #1]/contacts/items/phone/items/number became optional for the status 200

      response-property-became-optional

  • 4bfab0afa6ca9See the full diff
    • ○

      added the optional property validation to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 402 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 409 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 503 status

      response-optional-property-added