1. Clientes
Yuv Cloud Services
prod
  • prod
  • quality
  • Introdução
  • Referências
  • Data Push
    • /pushFileDownloadRequest
    • /occurrence
    • JC181
      • /jc181/pushHeartbeat
      • /jc181/pushGps
      • /jc181/pushAlarm
      • /jc181/pushAlarmFile
      • /jc181/pushFileList
    • JC182
      • /jc182/pushGps
      • /jc182/pushHeartbeat
      • /jc182/pushFileList
      • /jc182/pushAlarm
      • /jc182/pushAlarmFile
    • JC371
      • /jc371/pushGps
      • /jc371/pushHeartbeat
      • /jc371/pushAlarm
      • /jc371/pushAlarmFile
      • /jc371/pushFileList
    • JC400
      • /jc400/pushHeartbeat
      • /jc400/pushGps
      • /jc400/pushAlarm
      • /jc400/pushAlarmFile
      • /jc400/pushFileList
    • JC450
      • /jc450/pushHeartbeat
      • /jc450/pushGps
      • /jc450/pushAlarm
      • /jc450/pushAlarmFile
      • /jc450/pushFileList
  • API (Revendedor)
    • Alarmes
      • Obter Alarmes
    • Ativos
      • Obter lista
      • Visualizar
      • Cadastrar
      • Editar
      • Vincular/Desvincular equipamento
      • Deletar
    • Equipamentos
      • Obter lista para seleção
      • Obter lista
      • Abrir streaming
      • Visualizar
      • Cadastrar
      • Editar
      • Deletar
      • Enviar comando
    • Clientes
      • Obter lista
        GET
      • Editar
        PUT
      • Obter token
        GET
      • Cadastrar token
        POST
      • Cadastrar
        POST
      • Deletar
        DELETE
      • Deletar token
        DELETE
    • Downloads
      • Requisitar lista de arquivos
      • Requisitar arquivo
    • Playback
      • Streaming
    • Motoristas
      • Obter lista
      • Cadastrar
    • Ocorrências
      • Obter lista
      • Tratativa
    • Grupo de Permissão
      • Obter lista
    • GPS
      • Obter GPS
      • Obter Deslocamento
    • Manutenções
      • Obter lista
    • Abastecimentos
      • Obter lista
  • API (Cliente)
    • Controle de Acesso
    • Alarmes
      • Obter Alarmes
    • Equipamentos
      • Obter lista
      • Abrir streaming
    • Motoristas
      • Obter lista
      • Cadastrar
    • Ocorrências
      • Tratativa
      • Obter lista
    • GPS
      • Obter GPS
      • Obter Deslocamento
    • Manutenções
      • Obter lista
    • Abastecimentos
      • Obter lista
  1. Clientes

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.
Clientes cujo usuário principal está desativado não aparecem.

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
🟠422Unprocessable Entity
🟠429Too Many Request
🔴500Internal server error
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 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-15 18:09:10
Página anterior
Enviar comando
Próxima página
Editar
Built with