HomeGuíasAPI ReferenceChangelog
Log In
API Reference
  1. Recursos principales
  2. Customers

Listar Customers

get
https://api.trytoku.com/customers

Devuelve una lista paginada de Customers de la organización.

Se usa para recorrer o buscar Customers; para obtener un Customer puntual por su identificador prefiere el endpoint de detalle. Los filtros (mail, external_id, rfc, rango de fechas de creación) son opcionales y se combinan con AND. La paginación es por cursor: entrega page_size elementos y, si hay más, un next_cursor que debes reenviar en la siguiente llamada.

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≤ 100
Defaults to 50

Cantidad máxima de elementos por página (entre 1 y 100).

string

Cursor de la página siguiente. Envía el next_cursor devuelto en la respuesta anterior para continuar; omítelo en la primera llamada.

string

Filtra los Customers por correo electrónico.

string

Filtra los Customers por su identificador externo definido por la organización.

string

Filtra los Customers por su RFC (México).

date-time

Devuelve solo los Customers creados desde esta fecha y hora (inclusive), en formato ISO 8601.

date-time

Devuelve solo los Customers creados hasta esta fecha y hora (inclusive), en formato ISO 8601.

Headers
string

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

date

Versión del API para esta petición, como cualquier fecha YYYY-MM-DD. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.

Responses

Updated 5 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago

Did this page help you?