Skip to main content
GET
/
people
Listar contatos
curl --request GET \
  --url http://localhost:3001/people/ \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "imageUrl": "<string>",
      "phoneNumber": "<string>",
      "document": "<string>",
      "description": "<string>",
      "country": "<string>",
      "city": "<string>",
      "isBlocked": true,
      "inboxId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "conversationId": "<string>",
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      ]
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.jurichat.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-JuriChat-Api-Key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header X-JuriChat-Api-Key.

Query Parameters

page

Número da página.

limit

Quantidade de itens por página.

inboxId
string
required

ID da inbox. Obrigatório para filtrar os contatos.

name
string

Filtra por nome (parcial) ou por trecho do telefone quando o texto contiver números.

email
string<email>

Filtra por e-mail (correspondência parcial).

isBlocked
boolean

Filtra por status de bloqueio: true ou false.

tags

Filtra contatos que possuam ao menos uma das tags informadas (IDs).

Response

Default Response

data
object[]
required

Itens da página atual.

totalResults
number
required

Total de registros encontrados.

totalPages
number
required

Total de páginas para a quantidade solicitada.