Rota de listagem

Como listar certificados do cliente via request HTTP.

Esta rota devolve os certificados cadastrados para o cliente autenticado, com suporte a paginação por limit e offset. O retorno inclui o id que deve ser usado nas rotas de vínculo e exclusão.

GET /api-esocial/sistema/certificados
Autenticação
Headers CNPJ + TOKEN
Parâmetros
limit e offset
Retorno
items, limit e offset
Query string

Parâmetros aceitos para paginação da listagem.

CampoObrigatórioTipoDescrição
limitNãointQuantidade máxima de itens. O padrão atual da rota é 200.
offsetNãointDeslocamento da paginação. O padrão atual da rota é 0.

Comportamento da rota

  • A listagem é sempre limitada ao cliente identificado pelos headers da requisição.
  • Os headers CNPJ e TOKEN são obrigatórios em todos os requests dessa API.
  • O retorno dessa rota é a forma padrão de descobrir o certificado_id usado em vínculo e exclusão.
  • O retorno expõe um resumo dos certificados, sem devolver o arquivo binário.
  • O backend normaliza o limit para o intervalo aceito pela API.
Exemplo prático

Exemplo de request para listar certificados.

A rota devolve status, message, cliente_id, a lista em items e os valores de paginação.

GET /api-esocial/sistema/certificados
cURL
curl -X GET "https://resocial.com.br/api-esocial/sistema/certificados?limit=20&offset=0" \
  -H "CNPJ: 12345678000190" \
  -H "TOKEN: seu_token_de_api"
GET /api-esocial/sistema/certificados
Python
import requests

url = "https://resocial.com.br/api-esocial/sistema/certificados"
headers = {
    "CNPJ": "12345678000190",
    "TOKEN": "seu_token_de_api",
}
params = {
    "limit": 20,
    "offset": 0,
}

response = requests.get(url, headers=headers, params=params, timeout=60)
print(response.status_code)
print(response.json())
INFO

Resposta esperada

A rota devolve status, message, cliente_id, a lista em items e os valores de paginação.

Resposta (JSON)
{
  "status": 200,
  "message": "Certificados listados com sucesso",
  "cliente_id": 12,
  "items": [
    {
      "id": 8,
      "nome": "Certificado matriz",
      "arquivo_nome": "certificado_matriz.pfx",
      "documento": "12345678000190",
      "vencimento": "2027-06-15T18:00:00",
      "ativo": 1,
      "atualizado_em": "2026-03-19T09:12:10"
    }
  ],
  "limit": 20,
  "offset": 0
}