Listar clientes

Permiso requerido: customers:read.

GET /public/v1/customers

Permiso customers:readClientes

Parámetros

Parámetros de consulta

Nombre	Tipo	Requerido	Descripción
`limit`	integer	No	Por defecto: `25`. Mínimo: 1. Máximo: 100.
`starting_after`	string	No	El `next_cursor` de la página anterior, tal cual.
`created_since`	string (date-time)	No	ISO 8601 con zona horaria. Incluye.
`created_until`	string (date-time)	No	ISO 8601 con zona horaria. Excluye.
`updated_since`	string (date-time)	No	ISO 8601 con zona horaria. Para sincronización incremental.
`email`	string	No	Coincidencia exacta, sin distinguir mayúsculas. Máximo 254 caracteres.
`document_number`	string	No	Número de documento, coincidencia exacta. Máximo 40 caracteres.
`q`	string	No	Busca en nombre, apellido, email, teléfono y documento. Mínimo 2 caracteres. Máximo 100 caracteres.
`include_deleted`	boolean	No	Si es `true`, incluye los registros eliminados (con `deleted_at`). Por defecto: `false`.

Ejemplo de petición

Terminal

curl "https://api.posdata.so/public/v1/customers?limit=25" \
  -H "Authorization: Bearer $POSDATA_API_KEY"

JavaScript

const res = await fetch('https://api.posdata.so/public/v1/customers?limit=25', {
  headers: {
    Authorization: `Bearer ${process.env.POSDATA_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message} (${data.error.request_id})`);

Python

import os

import requests

res = requests.get(
    "https://api.posdata.so/public/v1/customers",
    headers={
        "Authorization": f"Bearer {os.environ['POSDATA_API_KEY']}",
    },
    params={"limit": 25},
    timeout=30,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{data['error']['code']}: {data['error']['message']} ({data['error']['request_id']})")

PHP

<?php
$ch = curl_init('https://api.posdata.so/public/v1/customers?limit=25');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('POSDATA_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException("{$data['error']['code']}: {$data['error']['message']} ({$data['error']['request_id']})");
}

Respuesta

200 OK.

Campo	Tipo	Requerido	Descripción
`object`	`"list"`	Sí	—
`data`	arreglo de Customer	Sí	—
`has_more`	boolean	Sí	—
`next_cursor`	string \| null	Sí	—

Ejemplo de respuesta (valores ilustrativos)

{
  "object": "list",
  "data": [
    {
      "object": "customer",
      "id": "3f1c2e8d-7a10-4d0b-9a57-0b6f2f0e5c1d",
      "name": "Café molido 500 g",
      "last_name": "texto",
      "email": "[email protected]",
      "phone": "3001234567",
      "person_type": "texto",
      "document_type": "texto",
      "document_number": "texto",
      "contact_channel": "texto",
      "deleted_at": "2026-09-28T15:04:05.000Z",
      "created_at": "2026-09-28T15:04:05.000Z",
      "updated_at": "2026-09-28T15:04:05.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "texto"
}

Errores

Todo error responde con un objeto Error y un request_id. Ramifica por error.code, nunca por el mensaje.