Skip to main content
GET
/
user
/
{id}
Obter usuário
curl --request GET \
  --url http://localhost:3001/user/{id} \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "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,
  "inOnboarding": true,
  "permissions": [
    {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>"
    }
  ]
}

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.

Path Parameters

id
string
required

ID do usuário.

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

Response

Default Response

id
string
required

ID do usuário.

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

Nome do usuário.

email
string
required

E-mail de acesso.

contact
string
required

Telefone ou WhatsApp cadastrado.

imageUrl
string | null
required

URL de avatar. Null se não definido.

notificationSound
string
required

Arquivo de som de notificação.

officeId
string
required

ID do escritório ao qual o usuário pertence.

roleId
string
required

ID do papel atribuído ao usuário.

createdAt
string<date-time>
required

Data e hora de criação.

role
object
required
office
object
required
inboxes
object[] | null
required

Inboxes vinculadas ao usuário. Null se não houver.

lastInboxUsed
string | null
required

ID da última inbox utilizada. Null se não houver.

onlyAssignedConversations
boolean
required

Quando verdadeiro, o usuário visualiza apenas conversas atribuídas a ele.

inOnboarding
boolean
required

Indica se o usuário está no fluxo de onboarding.

permissions
object[]
required

Permissões ativas do usuário.