Listar clientes

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

Lista los clientes de la cuenta, con paginación, filtros y ordenación.

Requiere los headers X-Api-Key y User-Agent. Límite: 1 solicitud por segundo (más información).

Solicitud

Parámetros de consulta

limitinteger

Cantidad de ítems por página.

De 1 a 100.Predeterminado: 10.

offsetinteger

Cantidad de ítems que se omiten.

De 0 a 200000.Predeterminado: 0.

qstring

Filtros en el formato campo:valor, separados por espacios (cómo filtrar). Los filtros aceptados están en la tabla de abajo.

Ejemplo: document_number:27032236881 archived:false.

Filtro	Qué hace
name	Nombre del cliente, exactamente igual al registrado.
code	Código del cliente.
document_number	CPF o CNPJ (identificación fiscal brasileña) del cliente, solo números.
external_id	Identificador del cliente en su sistema (external.id).
archived	true para archivados, false para activos.
created_at	Fecha de creación igual a la informada (ISO 8601, UTC).
created_at>=	Creados a partir de la fecha informada, inclusive.
created_at<=	Creados hasta la fecha informada, inclusive.
created_at>	Creados después de la fecha informada.
created_at<	Creados antes de la fecha informada.

sortstring

Ordenación. -created_at ordena del más reciente al más antiguo.

Valores aceptados: id, created_at, -created_at.Predeterminado: id.

Headers

User-Agentstringobligatorio

Identificación de su aplicación.

Ejemplo: MinhaIntegracao/1.0.

Respuestas

• 200

  Lista de clientes.

• 401

  Clave de API ausente (Missing API Key) o inválida (Invalid API Key). Consulte Autenticación.

• 403

  Cuenta bloqueada (Account blocked), vencida (Account expired) o con un plan que no permite integración (Account plan not allowed). Consulte Autenticación.

• 422

  Filtro, paginación u ordenación inválidos (parametersValidationErr).

• 429

  Se superó el límite de 1 solicitud por segundo. Consulte Límite de solicitudes.

• 500

  Error inesperado en el servidor.