Buscar usuário

GET /user/{id}

Buscar usuário

cURL

curl --request GET \
  --url https://api.juridiq.com.br/user/{id} \
  --header 'x-juridiq-api-key: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "role": "<string>",
  "officeId": "<string>",
  "profile": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "document": "<string>",
  "contact": "<string>",
  "admissionDate": "<string>",
  "resignationDate": "<string>",
  "dateOfBirth": "<string>",
  "ctpsNumber": "<string>",
  "imageUrl": "<string>",
  "oabNumber": "<string>",
  "personType": "<string>",
  "salary": "<string>",
  "postalCode": "<string>",
  "addressNumber": "<string>",
  "firstLogin": true,
  "showBannerAsaas": true,
  "referralToken": "<string>"
}

Authorizations

x-juridiq-api-key · string · header · required

Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key.

Path Parameters

id · string<uuid> · required

ID do usuário

Response

200

application/json

Default Response

id · string · required

ID do usuário

name · string · required

Nome completo

email · string · required

E-mail de login

role · string · required

Cargo no escritório

officeId · string · required

ID do escritório

profile · object · required

Show child attributes

createdAt · string · required

Data de criação (ISO 8601)

updatedAt · string · required

Data da última alteração (ISO 8601)

document · string | null

CPF ou CNPJ

contact · string | null

Telefone ou contato

admissionDate · string | null

Data de admissão

resignationDate · string | null

Data de demissão

dateOfBirth · string | null

Data de nascimento

ctpsNumber · string | null

Número da CTPS

imageUrl · string | null

URL da foto

oabNumber · string | null

Número da OAB

personType · string | null

Tipo de pessoa. Ex: física, jurídica

salary · string | null

Salário

postalCode · string | null

CEP

addressNumber · string | null

Número do endereço

firstLogin · boolean | null

Primeiro acesso pendente

showBannerAsaas · boolean | null

Exibir banner Asaas

referralToken · string | null

Token de indicação