> For the complete documentation index, see [llms.txt](https://c2dbr-pt.gitbook.io/c2dbr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://c2dbr-pt.gitbook.io/c2dbr/api-and-webhooks/clients-get.md).

# clients (GET)

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

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2FIlLcy5weX4qV51NOw7Pz%2Fimage.png?alt=media\&token=ef419fd5-6b8d-46c6-bc77-5d34903abe8e)

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):

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2FBssn8Iqvh3MOLu6aGbuh%2Fimage.png?alt=media\&token=a3a3dff9-2a78-43e8-88e2-0d56b69a9094)

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

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2FVKLoUuWqDfZfLlwd4pUK%2Fimage.png?alt=media\&token=10822819-b5f9-4eb9-9356-e0a3d0dd56c3)

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.

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2Fbod6QkmYcMJFN4SC8VnD%2Fimage.png?alt=media\&token=bbe7d29d-2666-424e-aeb0-fc57645584f2)

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.

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2F5cMpO7jqjO6p0u2hlbqW%2Fimage.png?alt=media\&token=1d1f8c4e-ef1d-4330-a55c-e750d033155c)