Buscar usuário

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

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/user/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/user/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/user/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/user/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "role": "<string>",
  "officeId": "<string>",
  "profile": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "hasGoogleLinked": true,
  "hasPassword": true,
  "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>",
  "googleIntegrationType": "full-sync",
  "googleEmail": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

GET

user

{id}

Buscar usuário

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

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/user/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.juridiq.com.br/user/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-juridiq-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/user/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/user/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "role": "<string>",
  "officeId": "<string>",
  "profile": {
    "id": "<string>",
    "name": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "hasGoogleLinked": true,
  "hasPassword": true,
  "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>",
  "googleIntegrationType": "full-sync",
  "googleEmail": "<string>"
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<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. A API aberta aplica rate limit por chave (veja a documentação de integradores).

Path Parameters

string<uuid>

required

ID do usuário

Response

Default Response

string

required

ID do usuário

name

string

required

Nome completo

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)

hasGoogleLinked

boolean

required

Possui conta Google vinculada

hasPassword

boolean

required

Possui senha cadastrada

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

Primeiro acesso pendente

showBannerAsaas

boolean | null

Exibir banner Asaas

referralToken

string | null

Token de indicação

googleIntegrationType

enum<string> | null

Tipo de integração Google

Available options:

full-sync

googleEmail

string | null

E-mail da conta Google vinculada

Primeiros Passos

API Reference

Buscar usuário

Authorizations

Path Parameters

Response