Pular para conteúdo

Endpoints

A API expõe quatro endpoints, todos sob a tag Consultas e todos do tipo GET. Para experimentá-los no navegador, use a Referência interativa.

Consultar registros de uma entidade

GET /api/v1/{entity}

Consulta registros de uma entidade. Retorna o total de registros e a lista de objetos encontrados.

Parâmetros

Nome Em Obrigatório Tipo Descrição
entity path ✅ string Nome da entidade.
searchParams query — string Parâmetros JSON codificado.

Respostas

Código Significado
200 Sucesso — retorna uma lista de entidades.
400 Parâmetro inválido ou requisição malformada.
401 Chave de API ausente ou inválida.
403 Permissão negada.
404 Recurso não encontrado.
500 Erro interno no servidor. 
curl -i -H "X-Api-Key: SUA_CHAVE_AQUI" \
  "https://integracao.gob.com.br/api/v1/Account"

curl.exe -i -H "X-Api-Key: SUA_CHAVE_AQUI" `
  "https://integracao.gob.com.br/api/v1/Account"

Consultar uma entidade por ID

GET /api/v1/{entity}/{id}

Retorna os dados de uma única entidade pelo seu ID. Não retorna total nem list, apenas o objeto da entidade.

Parâmetros

Nome Em Obrigatório Tipo Descrição
entity path ✅ string Nome da entidade.
id path ✅ string ID da entidade.

Respostas

Código Significado
200 Sucesso — retorna uma única entidade.
400 Parâmetro inválido ou requisição malformada.
401 Chave de API ausente ou inválida.
403 Permissão negada.
404 Recurso não encontrado.
500 Erro interno no servidor. 
curl -i -H "X-Api-Key: SUA_CHAVE_AQUI" \
  "https://integracao.gob.com.br/api/v1/Account/688836cc750cfcf43"

curl.exe -i -H "X-Api-Key: SUA_CHAVE_AQUI" `
  "https://integracao.gob.com.br/api/v1/Account/688836cc750cfcf43"

Consultar registros relacionados

GET /api/v1/{entity}/{id}/{relationshipName}

Consulta registros relacionados a uma entidade.

Nome da relação em camelCase

O nome da relação deve estar em camelCase, iniciando com letra minúscula.

Parâmetros

Nome Em Obrigatório Tipo Descrição
entity path ✅ string Nome da entidade.
id path ✅ string ID da entidade.
relationshipName path ✅ string Nome da relação (em camelCase).

Respostas

Código Significado
200 Sucesso — retorna uma lista de entidades.
400 Parâmetro inválido ou requisição malformada.
401 Chave de API ausente ou inválida.
403 Permissão negada.
404 Recurso não encontrado.
500 Erro interno no servidor. 
curl -i -H "X-Api-Key: SUA_CHAVE_AQUI" \
  "https://integracao.gob.com.br/api/v1/Account/688836cc750cfcf43/parcelamentos"

curl.exe -i -H "X-Api-Key: SUA_CHAVE_AQUI" `
  "https://integracao.gob.com.br/api/v1/Account/688836cc750cfcf43/parcelamentos"

Download de arquivos

GET /api/v1/Attachment/file/{id}

Retorna um arquivo (anexo) a partir do seu ID.

Parâmetros

Nome Em Obrigatório Tipo Descrição
id path ✅ string ID da entidade (anexo).

Respostas

Código Significado
200 Sucesso — retorna um arquivo.
400 Parâmetro inválido ou requisição malformada.
401 Chave de API ausente ou inválida.
403 Permissão negada.
404 Recurso não encontrado.
500 Erro interno no servidor. 
curl -H "X-Api-Key: SUA_CHAVE_AQUI" \
  "https://integracao.gob.com.br/api/v1/Attachment/file/688836cc750cfcf43" \
  --output arquivo

curl.exe -H "X-Api-Key: SUA_CHAVE_AQUI" `
  "https://integracao.gob.com.br/api/v1/Attachment/file/688836cc750cfcf43" `
  --output arquivo

Por que sem -i aqui?

Neste endpoint a resposta é o próprio arquivo. O -i gravaria os cabeçalhos HTTP dentro do arquivo baixado, corrompendo-o. Para inspecionar os cabeçalhos sem afetar o download, use -D - (mostra os cabeçalhos no terminal e salva o arquivo com --output).

Formato das respostas

Retornado pelos endpoints de listagem e de relacionamentos.

{
  "total": 2,
  "list": [
    {
      "id": "688836cc750cfcf43",
      "name": "Nome de A",
      "deleted": false,
      "description": "Descrição da A",
      "createdAt": "2025-07-28 23:49:48",
      "modifiedAt": "2025-08-11 11:59:03"
    },
    {
      "id": "688836cc754c5cdaa",
      "name": "Nome de B",
      "deleted": false,
      "description": "Descrição da B",
      "createdAt": "2025-07-29 10:15:22",
      "modifiedAt": "2025-08-10 14:42:00"
    }
  ]
}

Retornado pelo endpoint de consulta por ID.

{
  "id": "638836cc750cfcfab",
  "name": "Nome",
  "deleted": false,
  "description": "teste",
  "createdAt": "2025-07-28 23:49:48",
  "modifiedAt": "2025-08-11 11:59:03"
}