Buscar clientes

Busca clientes en el sistema usando criterios de búsqueda. Permite encontrar clientes por nombre, documento u otros datos específicos.

---

Entorno

URL base: https://api.guarani.app

Endpoint

GET /clientes/search?q={query}&page=1&limit=100

Ejemplo de solicitud

curl -X GET "https://api.guarani.app/clientes/search?q={query}&page=1&limit=100" \
  -H "x-api-key: Bearer <access_token>" \
  -H "Accept: application/json" | jq

Nota: Asegúrate de reemplazar {query} por el parametro a buscar y <access_token> con un token JWT válido proporcionado por el equipo Guarani. Importante:
Es imprescindible incluir un token de acceso válido en el encabezado x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.

---

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
query	string	Si	Parámetro de busqueda
page	integer	No	Número de página. Por defecto: 1.
limit	integer	No	Resultados por página. Por defecto: 100

Encabezados de la Solicitud

Encabezado	Valor	Descripción
x-api-key	Bearer <access_token>	Token de autenticación necesario para acceder al recurso.
Accept	application/json	Indica que la respuesta debe devolverse en formato JSON.

Ejemplo de respuesta

{
  "success": true,
  "codigo": "200",
  "message": "Operación realizada correctamente.",
  "data": [
    {
      "id": "658686dc-93b5-44d5-b294-906f736035aa",
      "tipo_persona": 1,
      "tipo_documento": 1,
      "documento": "1234567",
      "nombre": "Cliente Ejemplo",
      "nombre_fantasia": "Cliente Ejemplo",
      "nacionalidad": "PRY",
      "fecha_nacimiento": "11/09/2025",
      "whatsapp": "+595981234567",
      "email": "[email protected]",
      "direccion": "Calle 123",
      "numero_casa": "0",
      "barrio": "Barrio Ejemplo",
      "ciudad": {
        "id": "67ef2e9f-0fa7-43e7-ad5e-87a694e56341",
        "nombre": "SANTA RITA",
        "codigo_sifen": "3556",
        "distrito": {
          "id": "78d49201-91f9-4e6c-aadb-4927f56767c0",
          "nombre": "SANTA RITA",
          "codigo_sifen": "209",
          "departamento": {
            "id": "750d3163-6a53-45df-b349-e8139d1ff3a9",
            "nombre": "ALTO PARANA",
            "codigo_sifen": "11"
          }
        }
      }
    }
  ],
  "pagination": {
    "total_registros": 1,
    "pagina": 1,
    "total_paginas": 1
  }
}

Descripción de Campos de Respuesta

Campos principales

Campo	Tipo	Descripción
id	uuid	Identificador único del cliente.
tipo_persona	number	Tipo de persona. 1 = Persona Física, 2 = Persona Jurídica.
tipo_documento	number	Tipo de documento. 1 = Cédula, 2 = Pasaporte, 3 = RUC, etc.
documento	string	Número del documento de identidad del cliente.
nombre	string	Nombre completo del cliente (razón social para personas jurídicas).
nombre_fantasia	string	Nombre comercial o fantasía del cliente.
nacionalidad	string	Código de nacionalidad en formato ISO 3166-1 alpha-3 (ej: PRY, ARG, BRA).
fecha_nacimiento	string	Fecha de nacimiento del cliente en formato DD/MM/YYYY.
whatsapp	string	Número de WhatsApp del cliente en formato internacional.
email	string	Dirección de correo electrónico del cliente.
direccion	string	Dirección completa del cliente.
numero_casa	string	Número de casa o edificio de la dirección del cliente.
barrio	string	Nombre del barrio donde reside el cliente.
ciudad	objeto	Objeto con información de la ciudad del cliente. (ver ciudades)

Campos de ciudad

Campo	Tipo	Descripción
id	uuid	Identificador único de la ciudad.
nombre	string	Nombre de la ciudad.
codigo_sifen	string	Código de la ciudad según el catálogo SIFEN.
distrito	objeto	Objeto con información del distrito al que pertenece la ciudad.

Campos de distrito

Campo	Tipo	Descripción
id	uuid	Identificador único del distrito.
nombre	string	Nombre del distrito.
codigo_sifen	string	Código del distrito según el catálogo SIFEN.
departamento	objeto	Objeto con información del departamento.

Campos de departamento

Campo	Tipo	Descripción
id	uuid	Identificador único del departamento.
nombre	string	Nombre del departamento.
codigo_sifen	string	Código del departamento según el catálogo SIFEN.

Campos de paginación

Campo	Tipo	Descripción
total_registros	number	Cantidad total de clientes que coinciden con la búsqueda.
pagina	number	Número de página actual.
total_paginas	number	Cantidad total de páginas disponibles.

Recursos adicionales

Para más información sobre posibles errores relacionados, consulta la sección errores.