# clients (GET)

Retorna uma lista de clientes com sua informação. Request (pedido):

![](/files/xbESTLrMfL1gFtsPLNgr)

Parâmetros:

• – id do cliente.ISe omitido, a lista completa de clientes é enviada.&#x20;

• Se o parâmetro transport é especificado, então a lista de transportes disponíveis para o cliente especificado é retornado.&#x20;

• Se o parâmetro last\_question é especificado, então o ultimo item do menu enviado ao cliente é retornado.&#x20;

• Se o parâmetro dialogs é especificado, então a lista de conversas do cliente é retornada.&#x20;

• Se o parâmetro questions é especificado, então uma lista de itens do menu que foram enviados ao cliente usando scripts é retornada.Opcionalmente, é possível especificar o interval de tempo.&#x20;

• phone – Filtro do número de telefone do cliente.&#x20;

• tags– filtro de tags,separadas por vírgula. Clientes com pelo menos uma tag da lista são retornados.&#x20;

• created\_after – clientes com a data de criação (rastreada pela primeira mensagem) depois \*\*\*\*\*\*\*\*\*\*after specified unix time are returned.&#x20;

• order (asc or desc) – (crescente ou decrescente) – ordem dos registros é retornada . O padrão é ordem crescente.

Se id ou phone são omitidos, uma lista complete de clientes é retornada. Resposta típica sem id do cliente especificado (lista complete de clientes):

![](/files/42wqivsMFHOal26hcTKP)

Resposta típica quando o id do cliente é especificado(um cliente com informações estendidas):

![](/files/euaG7e3llenRc80RiDC0)

Alguns campos:&#x20;

• assigned\_name – ao nome atribuído ao cliente – veja clients (PUT).&#x20;

• comment –comentário sobre o cliente, feito por um operador.&#x20;

• custom\_fields – dados json dos campos personalizados do seu cliente com seu id, nome e valor. Esses campos são visíveis para operadores no cadastro do cliente. Eles podem ser controlados pelo admin na seção Configurações > Geral.&#x20;

• phone – número de telefone do cliente, se existe. Disponível apenas para WhatsApp, Viber, Viber Business e SMS. Para outros mensageiros, é armazenado o id do mensageiro respective. Veja também client\_phone abaixo.

• client\_phone – número do cliente se o cliente revelou seu número de telegone em mensageiros que não os exibem por padrão (atualmente telegram e facebook).&#x20;

• name – apelido do cliente na plataforma(se disponível). Veja abaixo uma resposta típica ao especificar id do cliente e key do transporte/canal. Esses, na verade, são os transportes (com canais) que dado cliente usou para conversar com a sua central de conversas e podem ser usados para responder para esse cliente.

![](/files/N7vdAbdbOxl4V1tgrvYe)

Veja abaixo uma resposta típica ao especificar o id do cliente e a key last\_question. Esserequest retorna o ultimo item do menu enviado a esse cliente mais cedo.

![](/files/79fd5hlZWpuxYhbbNfIY)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://c2dbr-pt.gitbook.io/c2dbr/api-and-webhooks/clients-get.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.