Consultar solicitações

Endpoints

Método	URL
GET	https://{{url}}/cube/api/v3/solicitacoes/minhas
GET	https://{{url}}/cube/api/v3/solicitacoes/recebidas
GET	https://{{url}}/cube/api/v3/solicitacoes/finalizadas

Respostas

Exemplo de corpo da resposta

{
"total": 1,
    "resultado":[
        {
            "id": 202405541,
            "idMeioComunicacao": 6,
            "meioComunicacao":{"id": 6, "descricao": "CRM"},
            "dataCadastro": "2025-09-30T15:32:47.676Z",
            "dataLimite": "2025-10-07T15:32:47.677Z",
            "idOrgao": 3660,
            "orgaoTratamento":{
                "id": 3660, 
                "orgao": "Teste Orgão"
            },
            "statusSolicitacao": "ABERTA",
            "protocolo": "202405541",
            "tipoSolicitacao": {
                "id": 954, 
                "descricao": "Teste", 
                "navegacao": "Desenvolvimento"                
            },
            "alteravel": true,
            "anonimo": false,
            "sigilo": false,
        }
    ]
}

Parâmetros

É possível adicionar parâmetros adicionais na pesquisa de solicitações.

Parâmetro	Descrição
idsOrgao	Permite filtrar a pesquisa por órgãos específicos.
page	Paginação - permite navegar pelas páginas quando houverem muitos resultados
pageSize	Paginzação - Permite ajustar a quantidade de registros que retornarão na lista. Limitados a 30 registros por consulta

Exemplo de requisição utilizando os parâmetros

https://apiendpoint/cube/api/v3/solicitacoes/finalizadas?page=1&pageSize=30&idsOrgao=3,4

Dicionário dos dados retornados na API

Chave	Descrição
id	ID da solicitação
descricao	Descrição da solicitação - preenchida no momento da abertura
tipoSolicitacao.descricao	Nome do tipo solicitação
tipoSolicitacao.navegacao	Navegação da taxonomia de seções até o tipo solicitação da solicitação
idMeioComunicacao	ID do meio de comunicação de abertura
dataCadastro	Data de cadastro da solicitação
orgaoTratamento.orgao	Nome do órgão atual de tratamento da solicitação quando aplicável
statusSolicitacao	Status atual da solicitação
protocolo	ID da solicitação com os 0 iniciais
alteravel	Quando "true", a solicitação permite que novos históricos sejam inseridos
anonimo	Se "true", os dados da pessoa não existem na base de dados.
sigilo	Se "true", os dados da pessoa existem em base de dados, mas não podem ser visualizados.

Status da resposta

Status	Descrição
200	OK - Retorna os detalhes da solicitação.
404	Usuário sem permissão para visualizar solicitações ou não está vinculado ao(s) orgão(s) atuais da solicitação.

Permissões necessárias

Permissão	Descrição
resolucao:solicitacoes:visualizar	Permite que solicitações sejam visualizadas via API