---
title: "Exibir cliente"
method: GET
path: "/clients/{id}"
tags: ["Clientes"]
---

# Exibir cliente

`GET /clients/{id}`

Exibe informações detalhadas sobre um determinado cliente.

Ao informar o parâmetro `show_entities`, será adicionado um atributo de nome `entities` na resposta dessa requisição. Contendo a lista de entidades vinculadas nesse cliente (onde apenas entidades preenchidas serão exibidas).

> Se você deseja visualizar mais informações dos *contatos*, *endereços*, *grupos técnicos* ou *mesas* vinculados nesse cliente (além de seus respectivos IDs), você pode utilizar as seguintes rotas de Relacionamentos:
> * [Listar contatos](#get-/clients/-client_id-/contacts)
> * [Listar endereços](#get-/clients/-client_id-/addresses)
> * [Listar mesas](#get-/clients/-id-/desks)
> * [Listar grupos técnicos](#get-/clients/-id-/technical-groups)

## Path parameters

- `id` integer, required

## Query parameters

- `show_entities` boolean

## Response `200`

- union
  - object
    - `id` integer — ID do cliente
    - `address_ids` integer[] — ID dos endereços cadastrados no cliente
    - `anotations` string, nullable — Campo de anotações do cadastro do cliente
    - `authorization_flow` boolean — Se o fluxo de autorização para novos tickets está ativo ou não no cliente
    - `billing_report_type` 'detailed_with_appointment' | 'detailed' | 'synthetic' | '' — Relatório de fechamento do faturamento, pode ser 3 valores
    - `contact_ids` integer[] — ID dos contatos cadastrados no cliente
    - `desk_ids` integer[] — ID das mesas vinculadas no cliente
    - `email_financial` string — E-mail principal de envio de faturamento
    - `equipment_counter` integer — Contagem de quantos equipamentos tem cadastrados no cliente
    - `estadual_registration` string, nullable — Inscrição estadual
    - `form_of_payment` 'BOLETO' | 'CREDIT_CARD' | 'UNDEFINED' | 'PIX' — Tipo de pagamento definido para integrações de faturamento
    - `group_counter` integer — Contagem de quantos grupos de recursos tem cadastrados no cliente
    - `logo` string, nullable — URL de acesso para a imagem definida de logo do cliente
    - `max_agents` integer — Máximo de agentes definidos no cliente
    - `municipal_registration` string, nullable — Inscrição municipal
    - `name` string — Nome do cliente
    - `quarterly_bill_client_id` integer, nullable — Faturar em nome do cliente com esse ID
    - `quarterly_billing` boolean — Faturamento quarteirizado ativo?
    - `sms_financial` string, nullable — Envio de SMS para integrações de faturamento
    - `social` string — Razão social
    - `social_revenue` string, nullable — CPF/CNPJ
    - `status` boolean — Cliente ativo?
    - `technical_group_ids` integer[] — ID dos grupos técnicos vinculados no cliente
    - `user_counter` integer — Contagem de quantos usuários clientes tem cadastrados/vinculados no cliente
    - `user_ids` integer[] — ID dos usuários clientes vinculados no cliente
    - `work_folder` string, nullable — Pasta de trabalho
  - object
    - `client` object
      - `id` integer — ID do cliente
      - `name` string — Nome do cliente
      - `social` string — Razão social
      - `social_revenue` string, nullable — CPF/CNPJ
    - `entities` object[]
      - `id` integer — ID do campo personalizado
      - `active` boolean — O campo personalizado está ativo?
      - `applied_in` string — Onde o campo personalizado está aplicado/configurado
      - `description` string, nullable — Descrição do campo personalizado
      - `menu_item` boolean, nullable — É um item de menu?
      - `name` string — Nome do campo personalizado
      - `entity_fields` object[] — **Lista de campos, dos campos personalizados vinculados nesse objeto**
        - `id` integer, nullable — Identificador do valor preenchido
        - `field_type` 'email' | 'date' | 'currency' | 'phone' | 'checkbox' | 'text' | 'text_area' | 'single_select' | 'link' — Tipos de campo: "**email**", "**date**", "**currency**", "**phone**", "**checkbox**", "**text**", "**text_area**", "**single_select**", "**link**"
        - `name` string — Nome do campo
        - `required` boolean — Informa se o campo é de preenchimento obrigatório
        - `entity_field_id` integer — Identificador do campo
        - `entity_id` integer — Identificador do campo personalizado
        - `value` string, nullable — Valor preenchido
        - `options` object[] — **Lista com valores das opções preenchidas no campo** (utilizado em campos do tipo checkbox e single_select)
          - `id` integer — Identificador do valor preenchido
          - `entity_field_id` integer — Identificador do campo
          - `entity_field_option_id` integer — Identificador da opção
          - `title` string — Nome da opção
          - `value` string — Valor da opção

## Other responses

- `403` — ### **Problemas com permissão** Essa resposta significa que o seu grupo de permissões não possui a permissão necessária para acessar essa rota
- `404` — ### **Cliente não encontrado**

---

[API](https://skmtc.net/tiflux/apis/tiflux-official-api.md) · [All operations](https://skmtc.net/tiflux/apis/tiflux-official-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tiflux/tiflux-official-api/revisions/c656412a58bc/schema)