---
title: "Consultar lista de clientes"
method: GET
path: "/clients"
tags: ["Clientes"]
---

# Consultar lista de clientes

`GET /clients`

## Request

- Base URL: `https://api.pirpos.com`
- URL: `https://api.pirpos.com/clients`
- Auth: HTTP bearer

Consulta una lista paginada de clientes del negocio actual.

**Autenticación requerida:** Este endpoint requiere autenticación Bearer Token.
Usar el campo `tokenCurrent` obtenido del servicio de login (/login) en el header:
`Authorization: Bearer {tokenCurrent}`

**Características:**
- Soporta paginación para manejo eficiente de grandes listas
- Incluye filtros de búsqueda por nombre, teléfono, documento, email
- Búsqueda flexible con múltiples palabras clave
- Ordenación automática por nombre
- Respeta configuración de compartir clientes con negocio padre

**Limitaciones plan trial:** Las cuentas en periodo de prueba solo pueden ver clientes de las últimas 24 horas.

## Ejemplos de Uso

### 1. Consultar todos los clientes (primera página)
```
GET /clients?pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui
```
Consulta los primeros 10 clientes ordenados por nombre.

### 2. Buscar cliente por nombre
```
GET /clients?filter=Juan&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui
```
Busca clientes que contengan "Juan" en nombre o apellido.

### 3. Búsqueda por múltiples palabras
```
GET /clients?filter=Maria Lopez&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui
```
Busca clientes que contengan tanto "Maria" como "Lopez".

### 4. Búsqueda por teléfono
```
GET /clients?filter=300123&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui
```
Busca clientes por número de teléfono (búsqueda flexible con espacios).

### 5. Búsqueda avanzada por datos generales
```
GET /clients?clientData=empresa@email.com&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui
```
Busca en todos los campos del cliente (nombre, apellido, documento, email, teléfono, dirección).

## Query parameters

- `pagination` boolean
- `limit` integer
- `page` integer
- `filter` string
- `clientData` string

## Response `200`

Lista de clientes obtenida exitosamente

- union
  - Client[]
    - `_id` string: ID único del cliente
    - `business` string: ID del negocio al que pertenece el cliente
    - `isSocialReason` boolean: Indica si es una razón social (empresa)
    - `responsibilities` string: Responsabilidades tributarias
    - `responsibilityName` string: Nombre de la responsabilidad tributaria
    - `name` string: Nombre del cliente
    - `lastName` string: Apellido del cliente
    - `idDocumentType` number: Tipo de documento de identidad
    - `documentName` string: Nombre del tipo de documento
    - `document` string: Número de documento
    - `checkDigit` number: Dígito verificador del documento
    - `isVATCompanyType` boolean: Indica si es una empresa con IVA
    - `email` string, email: Correo electrónico del cliente
    - `phone` string: Número de teléfono del cliente
    - `address` string: Dirección del cliente
    - `cityDetail` object: Detalles de la ciudad
      - `countryCode` string: Código del país
      - `stateCode` string: Código del departamento
      - `stateName` string: Nombre del departamento
      - `cityCode` string: Código de la ciudad
      - `cityName` string: Nombre de la ciudad
    - `city` string: Ciudad del cliente (deprecado)
    - `postalCode` string: Código postal
    - `notes` string: Notas adicionales sobre el cliente
    - `deleted` boolean: Indica si el cliente está eliminado
    - `deletedInfo` object: Información de eliminación
      - `isDeleted` boolean: Indica si está eliminado
      - `deletedBy` string: Usuario que eliminó el cliente
      - `date` string, date-time: Fecha de eliminación
    - `modifiedOn` string, date-time: Fecha de última modificación
    - `createdOn` string, date-time: Fecha de creación
    - `birthdate` string, date: Fecha de nacimiento del cliente
    - `points` number: Puntos de fidelidad del cliente
    - `creditMovement` object[]: Historial de movimientos de crédito
      - `paymentMethod` object
        - `internalId` string: ID del método de pago
        - `name` string: Nombre del método de pago
      - `date` string, date-time: Fecha del movimiento
      - `total` number: Monto del movimiento
      - `notes` string: Notas del movimiento
  - object
    - `data` Client[]
      - `_id` string: ID único del cliente
      - `business` string: ID del negocio al que pertenece el cliente
      - `isSocialReason` boolean: Indica si es una razón social (empresa)
      - `responsibilities` string: Responsabilidades tributarias
      - `responsibilityName` string: Nombre de la responsabilidad tributaria
      - `name` string: Nombre del cliente
      - `lastName` string: Apellido del cliente
      - `idDocumentType` number: Tipo de documento de identidad
      - `documentName` string: Nombre del tipo de documento
      - `document` string: Número de documento
      - `checkDigit` number: Dígito verificador del documento
      - `isVATCompanyType` boolean: Indica si es una empresa con IVA
      - `email` string, email: Correo electrónico del cliente
      - `phone` string: Número de teléfono del cliente
      - `address` string: Dirección del cliente
      - `cityDetail` object: Detalles de la ciudad
        - `countryCode` string: Código del país
        - `stateCode` string: Código del departamento
        - `stateName` string: Nombre del departamento
        - `cityCode` string: Código de la ciudad
        - `cityName` string: Nombre de la ciudad
      - `city` string: Ciudad del cliente (deprecado)
      - `postalCode` string: Código postal
      - `notes` string: Notas adicionales sobre el cliente
      - `deleted` boolean: Indica si el cliente está eliminado
      - `deletedInfo` object: Información de eliminación
        - `isDeleted` boolean: Indica si está eliminado
        - `deletedBy` string: Usuario que eliminó el cliente
        - `date` string, date-time: Fecha de eliminación
      - `modifiedOn` string, date-time: Fecha de última modificación
      - `createdOn` string, date-time: Fecha de creación
      - `birthdate` string, date: Fecha de nacimiento del cliente
      - `points` number: Puntos de fidelidad del cliente
      - `creditMovement` object[]: Historial de movimientos de crédito
        - `paymentMethod` object
          - `internalId` string: ID del método de pago
          - `name` string: Nombre del método de pago
        - `date` string, date-time: Fecha del movimiento
        - `total` number: Monto del movimiento
        - `notes` string: Notas del movimiento
    - `count` integer: Total de clientes que coinciden con la búsqueda

## Other responses

- `401`: Token de autorización inválido o faltante
- `500`: Error interno del servidor

---

[API](https://skmtc.dev/loggro/apis/restobar-servicios-del-m-dulo-de-restobar.md) - [All operations](https://skmtc.dev/loggro/apis/restobar-servicios-del-m-dulo-de-restobar/llms.txt) - [OpenAPI document](https://skmtc.dev/loggro/apis/restobar-servicios-del-m-dulo-de-restobar/revisions/9d4431a3cddc?raw)