> For the complete documentation index, see [llms.txt](https://recursos.demandu.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://recursos.demandu.tech/centro-de-recursos-pt-br/guia-de-produtos-e-treinamento/contatos-e-chat-api/obter-todos-os-contatos.md).

# Obter Todos os Contatos

### 🔍 Obter a Caixa de Entrada de Usuários

Este endpoint permite recuperar dados de usuários da caixa de entrada, oferecendo diversas opções de filtro para personalizar a consulta.​

* **🛠️ URL do Endpoint:**

```
https://api.v7.express-chat.com/inbox/users
```

* **📨 Método HTTP:**\
  `POST`​

#### 🛡️ Cabeçalhos da Solicitação

É necessário um token Bearer válido para autenticação.​

* **Autorização:**\
  `Bearer [SEU_TOKEN]`​

*Observação:* Substitua `[SEU_TOKEN]` pelo seu token de API válido.​

#### 📝 Corpo da Solicitação

O corpo da solicitação deve ser um objeto JSON que contenha diversos critérios de filtro para personalizar a consulta. A seguir, estão detalhados os campos disponíveis:​

* **searchText** *(string)*:\
  Texto de busca para filtrar usuários.​
* **tags** *(array)*:\
  Um array de etiquetas para filtrar usuários.​
* **status** *(array)*:\
  Um array de valores de status para filtrar usuários.​
* **isOnline** *(boolean)*:\
  Indica se os usuários estão online.​
* **\_botWebsite** *(array)*:\
  Filtra usuários com base em interações no site.​
* **\_botWhatsapp** *(array)*:\
  Filtra usuários com base em interações no WhatsApp.​
* **\_botTelegram** *(array)*:\
  Filtra usuários com base em interações no Telegram.​
* **\_botFacebook** *(array)*:\
  Filtra usuários com base em interações no Facebook.​
* **\_agentAssigned** *(array)*:\
  Filtra usuários atribuídos a agentes específicos.​
* **segments** *(array)*:\
  Um array de segmentos para filtrar usuários.​
* **applicableFilters** *(array)*:\
  Um array de filtros aplicáveis.​
* **lastSeenAt** *(objeto)*:\
  Filtro de intervalo de datas para a última vez em que o usuário foi visto.​
* **createdAt** *(objeto)*:\
  Filtro de intervalo de datas para a data de criação.​
* **userInteracted** *(boolean)*:\
  Indica se os usuários interagiram.​
* **lastMessageBy** *(array)*:\
  Filtra usuários com base no remetente da última mensagem.​
* **isLiveChatActive** *(boolean)*:\
  Indica se o chat ao vivo está ativo para os usuários.​
* **hasOrdered** *(objeto)*:\
  Filtra usuários com base no histórico de pedidos.​

#### 🧪 Exemplo de Requisição

```bash
bashCopiarEditarcurl 'https://api.v7.express-chat.com/inbox/usersinbox/users' \
  -X 'POST' \
  -H 'Authorization: Bearer [SEU_TOKEN]' \
  -H 'Content-Type: application/json' \
  -d '{
    "searchText": "",
    "tags": [],
    "status": [],
    "isOnline": false,
    "_botWebsite": [],
    "_botWhatsapp": [],
    "_botTelegram": [],
    "_botFacebook": [],
    "_agentAssigned": [],
    "segments": [],
    "applicableFilters": ["userInteracted"],
    "lastSeenAt": {
      "startAt": "",
      "endsAt": ""
    },
    "createdAt": {
      "startAt": "",
      "endsAt": ""
    },
    "userInteracted": true,
    "lastMessageBy": [],
    "isLiveChatActive": false,
    "hasOrdered": {
      "status": false,
      "lastAt": ""
    },
    "page": 1,
    "isExport": "none",
    "isContact": true
  }' \
  --compressed
```

*Observação:* Substitua `[SEU_TOKEN]` na solicitação com seu token de API real e personalize os filtros do corpo da solicitação de acordo com suas necessidades específicas.​

#### 📬 Resposta

A API responderá com um objeto JSON que contém os dados dos usuários com base nos filtros aplicados. O formato da resposta pode variar dependendo dos dados disponíveis e dos filtros aplicados.​

{% hint style="info" %}
*Observação:* Certifique-se de lidar adequadamente com a resposta e considerar possíveis paginações se o número de resultados for grande.
{% endhint %}