List customers

GEThttps://carchost.fieldcontrol.com.br/customers

Lists the account's customers, with pagination, filters and sorting.

Requires the X-Api-Key and User-Agent headers. Limit: 1 request per second (learn more).

Request

Query parameters

limitinteger

Number of items per page.

From 1 to 100.Default: 10.

offsetinteger

Number of items to skip.

From 0 to 200000.Default: 0.

qstring

Filters in the field:value format, separated by spaces (how to filter). The accepted filters are in the table below.

Example: document_number:27032236881 archived:false.

Filter	What it does
name	Customer name, exactly as registered.
code	Customer code.
document_number	Customer's CPF or CNPJ (Brazilian tax ID), digits only.
external_id	Customer identifier in your system (external.id).
archived	true for archived, false for active.
created_at	Creation date equal to the given date (ISO 8601, UTC).
created_at>=	Created on or after the given date.
created_at<=	Created on or before the given date.
created_at>	Created after the given date.
created_at<	Created before the given date.

sortstring

Sorting. -created_at sorts from newest to oldest.

Accepted values: id, created_at, -created_at.Default: id.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Responses

• 200

  List of customers.

• 401

  API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

• 403

  Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

• 422

  Invalid filter, pagination or sorting (parametersValidationErr).

• 429

  Limit of 1 request per second exceeded. See Rate limit.

• 500

  Unexpected server error.