Mission Brasil

Listar coletas e entregas

Retorna uma listagem paginada de coletas e entregas em um período específico. Regras e observações: - `startedAt` e `endedAt` devem ser enviadas no formato `YYYY-MM-DD` - `progress` aceita `1` para iniciadas e `2` para finalizadas - o resultado é cacheado por 1 hora para melhor performance

GET
/delivery/results

Authorization

clientIdAuth clientSecretAuth
client-id<token>

Client ID gerado na plataforma Mission Brasil.

In: header

client-secret<token>

Client Secret gerado na plataforma Mission Brasil.

In: header

Query Parameters

startedAt*string

Data de início do período (formato YYYY-MM-DD)

Formatdate
endedAt*string

Data de fim do período (formato YYYY-MM-DD)

Formatdate
itemsPerPage*integer

Itens por página

Range1 <= value
progress*integer

Progresso da missão. 1 para iniciadas, 2 para finalizadas.

Value in1 | 2

Response Body

application/json

application/json

application/json

curl -X GET "https://api.missionbrasil.com.br/v1/delivery/results?startedAt=2024-01-01&endedAt=2024-01-31&itemsPerPage=10&progress=1"
{
  "total": 4,
  "page": 1,
  "itemsPerPage": 10,
  "data": [
    {
      "form_name": "Coleta de loja",
      "form_id": "789",
      "answer": "Coleta concluída"
    }
  ]
}
{
  "error": "startedAt and endedAt are required"
}
{
  "error": "Client ID ou Client Secret inválido ou ausente."
}