Skip to main content
GET
/
people
/
{peopleId}
Obter contato
curl --request GET \
  --url http://localhost:3001/people/{peopleId} \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "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

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

peopleId
string
required

ID do contato.

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

Query Parameters

inboxId
string
required

ID da inbox. Obrigatório para verificar que o contato pertence a essa caixa.

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

Response

Default Response

id
string
required

ID do contato.

name
string | null
required

Nome do contato. Null se não informado.

email
string | null
required

E-mail. Null se não informado.

imageUrl
string | null
required

URL de avatar. Null se não definido.

phoneNumber
string | null
required

Número de telefone. Null se não informado.

document
string | null
required

CPF, CNPJ ou outro documento. Null se não informado.

description
string | null
required

Anotações sobre o contato. Null se não informado.

country
string | null
required

País. Null se não informado.

city
string | null
required

Cidade. Null se não informado.

isBlocked
boolean
required

Indica se o contato está bloqueado.

inboxId
string
required

ID da inbox à qual o contato pertence.

createdAt
string<date-time>
required

Data e hora de criação.

updatedAt
string<date-time>
required

Data e hora da última atualização.

tags
object[]
required

Tags associadas ao contato.