Skip to main content
GET
/
people
/
{peopleId}
Obter pessoa
curl --request GET \
  --url http://localhost:3001/people/{peopleId} \
  --header 'Authorization: Bearer <token>'
{
  "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",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<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

​
Authorization
string
header
required

Insira o token JWT no formato: Bearer {token}

Path Parameters

​
peopleId
string
required

Identificador único (CUID) da pessoa.

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

Query Parameters

​
inboxId
string
required

Inbox na qual a pessoa deve existir; evita retorno de registro de outro contexto.

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

Response

Default Response

​
id
string
required

Identificador único da pessoa.

​
name
string | null
required

Nome da pessoa.

​
email
string | null
required

E-mail, se houver.

​
imageUrl
string | null
required

URL da imagem de perfil, se houver.

​
phoneNumber
string | null
required

Telefone cadastrado.

​
document
string | null
required

Documento, se houver.

​
description
string | null
required

Descrição ou notas, se houver.

​
country
string | null
required

País, se informado.

​
city
string | null
required

Cidade, se informada.

​
isBlocked
boolean
required

Indica se o contato está bloqueado.

​
inboxId
string
required

Inbox à qual a pessoa pertence.

​
createdAt
string<date-time>
required

Data e hora de criação do registro.

​
updatedAt
string<date-time>
required

Data e hora da última atualização.

​
tags
object[]
required

Tags associadas à pessoa.