Pular para o conteúdo principal
GET
cURL
Veja também:

Autorizações

Authorization
string
header
obrigatório

API key criada no portal do parceiro.

Parâmetros de consulta

status
enum<string>

Status do protocolo. Aceita um só valor. Status do protocolo.

Opções disponíveis:
creating,
protocol_generated,
appointment_scheduled,
certificate_issued,
cancelled,
creation_failed
certificate_type
enum<string>

Tipo do certificado. Tipo do certificado. e_cpf é para titular pf e e_cnpj para titular pj.

Opções disponíveis:
e_cpf,
e_cnpj
document
string

CPF (11 números) ou CNPJ (14 caracteres, com letras e números) do titular, sem pontuação. Não busca o CPF do representante legal.

created_after
string<date-time>

Início do período de criação, inclusive. Formato ISO 8601 em UTC, terminado em Z, como 2026-10-01T00:00:00Z. Não aceita deslocamento, como -03:00.

created_before
string<date-time>

Fim do período de criação, exclusive. Mesmo formato de created_after, terminado em Z.

limit
integer
padrão:20

Quantidade de protocolos por página. Mín. 1. Máx. 100. Padrão 20.

Intervalo obrigatório: 1 <= x <= 100
after
string

Cursor da próxima página: o protocol_id do último protocolo recebido. Não use junto com before.

Pattern: ^CPR_[0-9A-HJKMNP-TV-Z]{26}$
before
string

Cursor da página anterior: o protocol_id do primeiro protocolo recebido. Não use junto com after.

Pattern: ^CPR_[0-9A-HJKMNP-TV-Z]{26}$

Resposta

200 - application/json

Página de protocolos. Se has_more é true, peça a próxima página com after.

data
object[]
obrigatório

Protocolos da página, do mais novo para o mais antigo.

has_more
boolean
obrigatório

true se há mais protocolos depois desta página. Peça a próxima com after.

Exemplo:

true

object
string
obrigatório

Sempre list.

Allowed value: "list"