Skip to content

Customers

Request

Obtén los datos de tus clientes

Security
api-key
Query
pagenumber

Busca la página específica de clientes

Example:page=1
start_datestring, (date)

Fecha inicial de búsqueda en formato YYYY-MM-DD

Example:start_date=2024-01-01
end_datestring, (date)

Fecha final de búsqueda en formato YYYY-MM-DD

Example:end_date=2024-12-31
id_typestring

Especifica el tipo de documento a buscar

Enum:"cedula""pasaporte""ruc""rut""otro"
id_numberstring

Número de documento a buscar

Example:id_number=1234567890
platformstring

Plataforma de interacción

Enum:"whatsapp""messenger""instagram"
order_by_last_interactionstring

Ordena los clientes por la última interacción según la plataforma

Enum:"asc""desc"
curl -i -X GET \
  'https://app.mercately.com/retailers/api/v1/customers?page=1&start_date=2024-01-01&end_date=2024-12-31&id_type=cedula&id_number=1234567890&platform=whatsapp&order_by_last_interaction=asc' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultsinteger

Número total de resultados

Example:1
total_pagesinteger

Número total de páginas

Example:1
customersArray of objects

Lista de clientes

Response
{
  "results": 1,
  "total_pages": 1,
  "customers": [
    { … }
  ]
}
Copyleft © Mercately Inc.