Listar objetos Client

Permite recuperar la información de varios clientes mediante parámetros

GET /v3/clients

Ambiente	URL base API	Portal de comercio
Sandbox	https://api.virtualpos-sandbox.com	comercios.virtualpos-sandbox.com
Producción	https://api.virtualpos.cl	comercios.virtualpos.cl

Headers

Nombre	Tipo	Requerido	Descripción
Content-Type	string	No
Authorization	string	Sí	API KEY del comercio
Signature	string	Sí	Firma del mensaje

Parámetros de consulta

Nombre	Tipo	Requerido	Descripción
page	integer (int32)	No	Página a recuperar. Por defecto: 1.
limit	integer (int32)	No	Cantidad de registros por página. Por defecto: 100.
status	string	No	Filtra por estado del cliente: ACTIVO, BLOQUEADO. Valores: 'ACTIVO', 'BLOQUEADO'. Por defecto: all.
type	string	No	Filtra por tipo de cliente: PERSONA, EMPRESA. Valores: 'PERSONA', 'EMPRESA'.
social_id	string	No	Filtra por documento.
email	string	No	Fitra por email.
created_from	string	No	Filtra clientes creados desde esta fecha (inclusive).
created_to	string	No	Filtra clientes creados hasta esta fecha (inclusive).

Ejemplo de request

curl -X GET 'https://api.virtualpos-sandbox.com/v3/clients' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE"

Respuestas

200 OK

{
  "clients": [
    {
      "uuid": "cli_00183af742e91dc3",
      "status": "ACTIVO",
      "type": "PERSONA",
      "first_name": "John",
      "last_name": "Doe",
      "email": "user@example.com",
      "phone_number": "56961934502",
      "social_id_type": "RUT",
      "social_id": "12345678-9",
      "birth_date": "1990-01-01",
      "gender_id": "Masculino",
      "created": "2025-01-08 11:20:31",
      "updated": "2025-01-10 09:15:00"
    },
    {
      "uuid": "cli_00183af742e91dc4",
      "status": "BLOQUEADO",
      "type": "EMPRESA",
      "first_name": "Acme S.A.",
      "last_name": "",
      "email": "user2@example.com",
      "phone_number": "56223456789",
      "social_id_type": "RUT",
      "social_id": "76432154-2",
      "birth_date": “”,
      "gender_id": “”,
      "created": "2025-01-01 09:00:00",
      "updated": "2025-01-05 10:00:00"
    }
  ],
  "page": 1,
  "limit": 100,
  "total": 2
}

400 Bad Request

{
  "status": "NOK",
  "code": 400,
  "error": {
    "error_code": "E-###",
    "message": "detalle del error",
    "doc_url": "https://virtualpos.readme.io/reference/objeto-error"
  }
}