Listar atos

GET

/notices

const url = 'https://api.emmaos.com.br/notices?name=Maria&caseNumber=0801234&status=PENDING&limit=20';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.emmaos.com.br/notices?name=Maria&caseNumber=0801234&status=PENDING&limit=20' \
  --header 'Authorization: Bearer <token>'

Lista os notices do tribunal do token, do mais recente para o mais antigo, com paginação por cursor.

A lista não traz o documento-fonte nem os campos personalizados, para manter as respostas pequenas. Para isso, use GET /notices/{id}.

Authorizations

bearerAuth

Parameters

Query Parameters

name

string

Filtro por trecho do nome do destinatário.

Example

Maria

caseNumber

string

Filtro por trecho do número do processo.

Example

status

Progresso operacional do ato.

string

Allowed values: PENDING SENT VIEWED CONFIRMED IDENTITY_STARTED COMPLETED FAILED TIMED_OUT CANCELLED RECIPIENT_MISMATCH

Filtro exato por situação.

cursor

string

/^[A-Za-z0-9_-]+$/

O nextCursor da página anterior. Opaco: não construa um à mão.

limit

integer

default: 20 >= 1 <= 100

Quantidade máxima de itens na página. Omitido, valem 20. Acima de 100 a API não recusa: ela devolve 100 em silêncio; não conclua da página curta que a busca acabou, siga o nextCursor.

Example

Responses

200

Página de atos

application/json

object

items

required

Array<object>

Representação reduzida usada na listagem: sem documento-fonte, sem campos personalizados e com o processo resumido.

object

required

string format: uuid

protocol

required

string

noticeType

required

Natureza do ato a comunicar.

string

Allowed values: SUMMONS NOTICE NOTIFICATION

status

required

Progresso operacional do ato.

string

Allowed values: PENDING SENT VIEWED CONFIRMED IDENTITY_STARTED COMPLETED FAILED TIMED_OUT CANCELLED RECIPIENT_MISMATCH

recipient

required

O destinatário na listagem, sem o e-mail.

object

name

required

string

cpf

required

string

phone

required

string

case

required

A parte do processo que a listagem devolve.

object

number

required

string

courtDivision

required

string

deadlineAt

required

string | null format: date-time

createdAt

required

string format: date-time

nextCursor

required

Cursor da próxima página, ou null quando não há mais nada.

string | null

Example

{
  "items": [
    {
      "noticeType": "SUMMONS",
      "status": "PENDING"
    }
  ]
}

400

Requisição inválida

application/json

object

error

required

Código estável do erro. É por ele que se programa.

string

Allowed values: INVALID_REQUEST INVALID_JSON NOT_FOUND NOT_IMPLEMENTED TIMELINE_TOO_LONG DATABASE_RESUMING INTERNAL_ERROR SEALED_DOCUMENT_MISSING DISPATCH_IN_PROGRESS IDEMPOTENCY_KEY_CONFLICT SEALED_DOCUMENT_TOO_LARGE SOURCE_DOCUMENT_TOO_MANY_PAGES SOURCE_DOCUMENT_UNREADABLE STORAGE_LIMIT_REACHED TENANT_NOT_CONFIGURED

field

Campo que causou a recusa, quando aplicável.

string

message

Texto em português para diagnóstico. Não programe contra ele: pode mudar sem aviso.

string

missing

Só com TENANT_NOT_CONFIGURED: o que falta na configuração do tribunal.

Array<string>

Allowed values: displayName publicPhone whatsappSender

Examples

Campo obrigatório ausente ou malformado

{
  "error": "INVALID_REQUEST",
  "field": "noticeType",
  "message": "noticeType é obrigatório"
}

Corpo não é JSON válido

{
  "error": "INVALID_JSON",
  "message": "corpo JSON inválido"
}

401

Sem header Authorization. Recusado pelo API Gateway antes de chegar à aplicação.

403

Token inválido, expirado, ou de um emissor que não é tribunal conhecido neste stage. Recusado pelo authorizer.

500

Erro interno

application/json

object

error

required

Código estável do erro. É por ele que se programa.

string

field

Campo que causou a recusa, quando aplicável.

string

message

Texto em português para diagnóstico. Não programe contra ele: pode mudar sem aviso.

string

missing

Só com TENANT_NOT_CONFIGURED: o que falta na configuração do tribunal.

Array<string>

Allowed values: displayName publicPhone whatsappSender

Example

{
  "error": "INTERNAL_ERROR"
}

503

O banco do tribunal estava pausado e não retomou dentro do orçamento da requisição. Repita.

application/json

object

error

required

Código estável do erro. É por ele que se programa.

string

field

Campo que causou a recusa, quando aplicável.

string

message

Texto em português para diagnóstico. Não programe contra ele: pode mudar sem aviso.

string

missing

Só com TENANT_NOT_CONFIGURED: o que falta na configuração do tribunal.

Array<string>

Allowed values: displayName publicPhone whatsappSender

Example

{
  "error": "DATABASE_RESUMING",
  "message": "Banco de dados está retomando. Tente novamente."
}

Headers

Retry-After

integer

Segundos a esperar antes de repetir.