Sign in
Customers

List customers

Retrieve a paginated list of customers with filtering, search, and ordering capabilities.

get/public/v1/customers/

Query parameters

searchstring nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
codestring[] nullable
idinteger[] nullable
company_idinteger[] nullable
customer_typestring[] nullable
namestring nullable
name_exactstring nullable
unique_idstring nullable
emailstring nullable
websitestring nullable
addressstring nullable
countrySystemCountries[] nullable
statestring nullable
phonestring nullable
record_statusRecordStatus[] nullable
approval_statusstring[] nullable
approval_status_scopeRecordStatus[] nullable
orderingstring nullable
limitinteger

Number of records to return per page (capped at 100)

Number of records to return per page (capped at 100)

offsetinteger

Number of records to skip before starting to return results

Number of records to skip before starting to return results

Response

OK

countinteger required

Changes

Changed in 4 of the 27 revisions of this API.9

  • 1a2b927e2c1a1See the full diff
    • ○

      for the query request parameter country, the type was generalized from string null to array null

      request-parameter-type-generalized

  • 456ef8c02f623See the full diff
    • ○

      added the new optional query request parameter code

      new-optional-request-parameter

    • ○

      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

  • d0cd912ee42d4See the full diff
    • ○

      added the new optional query request parameter updated_after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter updated_before

      new-optional-request-parameter

    • ○

      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

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 77cd3c6ec7191See the full diff
    • ○

      added the new optional query request parameter approval_status_scope

      new-optional-request-parameter

Of the 27 revisions, 1 has no diff computed.