Listar Clientes

Visión General

Este endpoint permite Listar todos los clientes (Customer) dentro de la API de Passport proporcionando los datos de identificación necesarios. Una solicitud exitosa retorna un listado de todos los clientes y la información detallada de cada uno.

Detalles del Endpoint

Parámetro	Descripción
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/customers
Método	GET
Encabezados	Content-Type: application/json, Authorization
Autenticación	Token de Acceso (Bearer Token)

Parámetros de Consulta

Parámetros de Paginación

Parámetro	Descripción
page_params.page_size	Cantidad de registros a retornar por página.
page_params.page_number	Número de página a consultar.
page_params.first_request_timestamp.seconds	Segundos UTC desde Unix epoch (`1970-01-01T00:00:00Z`). Debe estar entre `0001-01-01T00:00:00Z` y `9999-12-31T23:59:59Z` (inclusive).
page_params.first_request_timestamp.nanos	Fracción en nanosegundos (0 a 999,999,999). Debe ser un valor no negativo y representa la fracción de segundo con resolución de nanosegundos.

Parámetros de Ordenamiento

Parámetro	Descripción
order_params.order_key	Campo utilizado para ordenar los resultados.
order_params.order_direction	Dirección del ordenamiento. Valores permitidos: `ORDER_DIRECTION_ENUM_UNSPECIFIED`, `ASC`, `DESC`.

Filtros de Clientes

Parámetro	Descripción
identification_number	Filtra por el número de identificación del cliente.
customer_id	Filtra por el identificador único del cliente.
identification_type	Filtra por el tipo de identificación del cliente (por ejemplo, `CC`, `NIT` ).

Cuerpo de la Solicitud

No requiere cuerpo de solicitud.

Ejemplo de Solicitud

JSON
    
 
curl --location --request GET 'https://api.paas.sandbox.co.passportfintech.com/v1/customers' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data ''
Copy

Cuerpo de la Respuesta

Código HTTP: 200 OK

Ejemplo de Respuesta

JSON
    
 
{
    "customers": [
        {
            "business_name": "changing",
            "type": "BUSINESS",
            "created_at": "2025-10-09T10:40:27.446Z",
            "updated_at": "2025-10-09T17:19:27.951Z",
            "email": "eAqpUh6u@example.com",
            "status": "ACTIVE",
            "identification_number": "903978023",
            "merchant_category_code": "0412",
            "mobile_phone_number": "573956158117",
            "address": {
                "line_3": "Calle 20 675",
                "city": "Cartagena",
                "line_1": "Diagonal 46 1104",
                "country": "CO",
                "post_code": "101010",
                "state": "Bolivar",
                "line_2": "Carrera 18 2111"
            },
            "identification_type": "NIT",
            "id": "db7e89e7-59d8-4ab1-b675-a2ae52c3339e"
        }
    ],
    "pagination_info": {
        "first_request_timestamp": "2025-10-09T17:35:17.864Z",
        "current_page": 1,
        "total_pages": 1,
        "total_elements": 1
    }
}
Copy

Errores Comunes y Manejo

Código HTTP	Significado	Descripción
400	Bad Request	Formato de solicitud inválido.
401	Unauthorized	Token Bearer ausente, expirado o sin alcance `paas.core.entity_customers.list.get`.
403	Forbidden	El solicitante no tiene permisos para listar los clientes.
404	Not Found	No existen clientes registrados para la entidad.
500	Server Error	Error inesperado en el servidor; reintente o contacte soporte.

Buenas Prácticas

Usa pagination_info para recuperar todos los clientes cuando la lista sea extensa.
Combina con Obtener Cliente (GET /customers/{id}) para acceder a información detallada de un cliente en particular.

Última actualización el