Skip to main content
GET
/
user
Listar usuários
curl --request GET \
  --url http://localhost:3001/user/ \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "contact": "<string>",
      "imageUrl": "<string>",
      "notificationSound": "<string>",
      "officeId": "<string>",
      "roleId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "role": {
        "id": "<string>",
        "name": "<string>"
      },
      "office": {
        "id": "<string>",
        "name": "<string>"
      },
      "inboxes": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "lastInboxUsed": "<string>",
      "onlyAssignedConversations": true
    }
  ],
  "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. Filtra usuários vinculados a essa caixa.

Pattern: ^[cC][^\s-]{8,}$

Busca por nome ou e-mail (correspondência parcial).

roleId
string

Filtra usuários pelo ID do papel (role).

Pattern: ^[cC][^\s-]{8,}$

Response

Default Response

data
object[]
required

Usuários da página atual.

totalResults
number
required

Total de registros encontrados.

totalPages
number
required

Total de páginas para a quantidade solicitada.