Listar audiências

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

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

fetch('https://api.juridiq.com.br/audience/', 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/audience/",
  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/audience/"

	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/audience/")

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

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "date": "<string>",
      "initialHour": "<string>",
      "finalHour": "<string>",
      "modality": "<string>",
      "type": "<string>",
      "audienceLink": "<string>",
      "description": "<string>",
      "processNumber": "<string>",
      "lawSuitId": "<string>",
      "personIds": [
        "<string>"
      ],
      "persons": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "personId": "<string>",
      "person": {
        "id": "<string>",
        "name": "<string>"
      },
      "completedAt": "2023-11-07T05:31:56Z",
      "points": 123,
      "isPrivate": true,
      "hasSheet": true,
      "location": "<string>",
      "participants": [
        {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "ownerId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "busy": true
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

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

Audiences

Listar audiências

Lista as audiências do escritório autenticado. Com page (começa em 1) e limit, pagina; sem limit, devolve todas. Por padrão, audiência privada só vem para quem a criou ou participa dela. date (AAAA-MM-DD, ou ISO com horário: vale o dia escrito, sem converter fuso) vale como start e end quando eles não vêm; start e end são inclusivos. type filtra pela modalidade (online, presencial, hibrida (minúsculas, sem acento)). lawSuit é o ID do processo e responsibles, IDs de usuários separados por vírgula. Ordem padrão: date decrescente; orderByField fora de date, createdAt e updatedAt: 400. Aceita JWT ou o header x-juridiq-api-key. Sem filtro de processo ou pessoa, vale o compartilhamento de agenda de quem consulta (a chave de API consulta como o dono dela): audiência de colega que não compartilha não vem; a de quem compartilha só livre/ocupado vem com título “Ocupado” e busy: true, com o conteúdo vazio (sem pessoas, processo, link, descrição e modalidade) (com title, ela não vem: o título casado revelaria o conteúdo). Gestor e Suporte não passam pelo compartilhamento.

GET

audience

Listar audiências

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

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

fetch('https://api.juridiq.com.br/audience/', 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/audience/",
  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/audience/"

	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/audience/")

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

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "date": "<string>",
      "initialHour": "<string>",
      "finalHour": "<string>",
      "modality": "<string>",
      "type": "<string>",
      "audienceLink": "<string>",
      "description": "<string>",
      "processNumber": "<string>",
      "lawSuitId": "<string>",
      "personIds": [
        "<string>"
      ],
      "persons": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "personId": "<string>",
      "person": {
        "id": "<string>",
        "name": "<string>"
      },
      "completedAt": "2023-11-07T05:31:56Z",
      "points": 123,
      "isPrivate": true,
      "hasSheet": true,
      "location": "<string>",
      "participants": [
        {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "ownerId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "busy": true
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

{
  "message": "<string>",
  "issues": "<unknown>"
}

{
  "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).

Query Parameters

page

string

Página. Começa em 1

limit

string

Itens por página

title

string

Filtra por título

type

enum<string>

Filtra por modalidade: online, presencial, hibrida (minúsculas, sem acento)

Available options:

online,

presencial,

hibrida

responsibles

string

Filtra por participantes: IDs de usuários separados por vírgula

isMetrics

string

true para métricas

date

string

Filtra um dia (AAAA-MM-DD; com horário ISO, vale o dia escrito): vale como start e end quando eles não vêm

lawSuit

string

Filtra pelo ID do processo

personId

string

Filtra por pessoa

orderBy

enum<string>

asc ou desc

Available options:

asc,

desc

orderByField

string

Campo de ordenação. date (ocorrência), createdAt, updatedAt

start

string

Data inicial (AAAA-MM-DD), inclusiva

end

string

Data final (AAAA-MM-DD), inclusiva

statusFilter

enum<string>

default:all

all = todas, completed = concluídas, pending = não concluídas

Available options:

all,

completed,

pending

Response

Default Response

data

object[]

required

Lista de audiências

Show child attributes

totalResults

number

required

Total de registros

totalPages

number

required

Total de páginas

Primeiros Passos

API Reference

Listar audiências

Authorizations

Query Parameters

Response