Clientes

Consultar lista de clientes

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).

get/clients

Request

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

Query parameters

paginationboolean

Activar paginación de resultados

limitinteger

Número máximo de clientes por página

pageinteger

Número de página (inicia en 0)

filterstring

Filtro de búsqueda por nombre, apellido, documento o teléfono

clientDatastring

Búsqueda avanzada en todos los campos del cliente

Response

Lista de clientes obtenida exitosamente

OR

Example response

[
  {
    "_id": "507f1f77bcf86cd799439021",
    "business": "507f1f77bcf86cd799439012",
    "responsibilities": "R-99-PN",
    "responsibilityName": "Régimen Simplificado",
    "name": "Juan",
    "lastName": "Pérez",
    "idDocumentType": 1,
    "documentName": "Cédula de Ciudadanía",
    "document": "12345678",
    "checkDigit": 9,
    "email": "juan@email.com",
    "phone": "+57 300 123 4567",
    "address": "Calle 123 #45-67",
    "cityDetail": {
      "countryCode": "CO",
      "stateCode": "11",
      "stateName": "Bogotá D.C.",
      "cityCode": "11001",
      "cityName": "Bogotá"
    },
    "city": "Bogotá",
    "postalCode": "110111",
    "notes": "Cliente preferencial con descuentos especiales",
    "deletedInfo": {
      "deletedBy": "507f1f77bcf86cd799439020",
      "date": "2025-08-05T10:30:00.000Z"
    },
    "modifiedOn": "2025-08-05T10:30:00.000Z",
    "createdOn": "2025-08-05T10:00:00.000Z",
    "birthdate": "1990-05-15",
    "points": 150,
    "creditMovement": [
      {
        "paymentMethod": {
          "internalId": "507f1f77bcf86cd799439030",
          "name": "Efectivo"
        },
        "date": "2025-08-05T10:30:00.000Z",
        "total": 50000,
        "notes": "Abono a cuenta"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.