Envio de eventos · Listar eventos
Listar eventos
Lista os eventos do ambiente da chave, mais novos primeiro. Os filtros usam os mesmos nomes do objeto do evento.
GET
https://integration.enviaesocial.com.br/v1/events
Autenticação
Bearer es_…
Corpo
Sem corpo
Sucesso
200
events
Filtros na URL
type
texto
opcional
Um tipo do catálogo, como S-2200.
status
texto
opcional
Uma situação do evento, como PROCESSED_SUCCESS.
employer_document
texto
opcional
CNPJ ou CPF, com ou sem máscara.
from
data
opcional
AAAA-MM-DD: recebidos a partir deste dia.
to
data
opcional
AAAA-MM-DD: recebidos até este dia, inclusive.
period
texto
opcional
AAAA-MM, do perapur.
client_reference
texto
opcional
A sua referência, exata.
receipt
texto
opcional
O número do recibo.
protocol
texto
opcional
O protocolo de envio.
worker_cpf
texto
opcional
O CPF do trabalhador ou do beneficiário, 11 dígitos, com ou sem máscara.
page
número
opcional
A página, a partir de 1 (padrão 1).
per_page
número
opcional
Itens por página, de 1 a 100 (padrão 20).
Respostas
200
events
A lista em data.items e a paginação em data.pagination.
422
validation_error
Filtro inválido; o field diz qual. Nada é corrigido em silêncio.
401
invalid_api_key
Chave ausente, inválida ou revogada.