Saltar al contenido principal
Version: Pro7

Listar Clientes por Estado

GET 

/api/customers/filter

Su propósito es obtener una lista de clientes filtrada por su estado.

Ejemplo:

Request

Query Parameters

Parámetros de consulta disponibles

    statusstringrequired

    posible values: active, inactive

    Example: active

Responses

Lista de clientes obtenida exitosamente

Schema
    successboolean
    Example: true
    messagestring
    Example: Clientes encontrados
    data object[]
    idinteger
    Example: 55
    descriptionstring
    Example: 72346556 - Pedro Diaz
    namestring
    Example: Pedro Diaz
    numberstring
    Example: 72346556
    identity_document_type_idstring
    Example: 1
    addressstring
    Example: Urb Sesquicentenario Vipol Callao
    emailstring
    Example: cliente@email.com
    telephonestring
    Example: 954533737
    statusstring
    Example: active
    created_atstring
    Example: 2023-08-17 10:30:00