Obter lista

GET

/customer

Lista, de forma paginada, os clientes do revendedor, já com os dados do usuário principal (root) de cada cliente.

Disponível para: Somente Revendedor
Rate limit: 100 requisições/minuto

⚠️ Apesar de ser GET, os filtros são enviados no corpo JSON da requisição (não na query string). O corpo é obrigatório: sem filtros, envie {} (sem corpo a API responde 400).

Regras

A paginação é controlada pela API (não há perPage).

customerCnpj vem sempre null nesta listagem.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

🟠400Bad request

🟠403Forbidden

🔴500Internal server error

🟠429Too Many Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.cloud-services.yuv.com.br/customer' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "search": "Transportadora",
    "page": 1
}'

Response Example

200 - Exemplo 1

{
    "currentPage": 1,
    "data": [
        {
            "customerId": 1,
            "customerName": "Customer123",
            "customerEmail": "email123@example.com",
            "customerIsEnabled": true,
            "permissionGroup": "PermissionGroup123",
            "occurrenceSetting": "OccurrenceSetting123",
            "customerCnpj": null,
            "customerZipCode": "00000-000",
            "customerAddress": "Address123",
            "customerComplement": "Complement123",
            "customerNeighborhood": "Neighborhood123",
            "customerCity": "City123",
            "customerState": "ST",
            "customerPhone": "00000000000",
            "customerObservation": "Observation123",
            "customerStreamingLimit": 10,
            "occurrenceSettingId": 1,
            "alarmSettingId": 1,
            "alarmSetting": "AlarmSetting123",
            "customerCreatedAt": "2026-01-01T00:00:00Z",
            "customerUpdatedAt": "2026-01-01T00:00:00Z",
            "userId": 1,
            "userName": "User123",
            "userIsEnabled": true,
            "userTypeId": 4,
            "permissionGroupId": 1,
            "languageId": 1,
            "language": "Language123",
            "timeZoneId": 13,
            "timeZone": "TimeZone123"
        }
    ],
    "lastPage": 1,
    "perPage": 20,
    "total": 1
}

Modificado em 2026-10-02 19:54:03

Obter lista

Regras#

Requisição

Respostas

Regras