Skip to main content
GET
/
transparency
/
orders
Listar ordens de fornecimento
curl --request GET \
  --url https://api-bid.startgov.com.br/v1/transparency/orders
{
  "success": true,
  "message": "Dados recuperados com sucesso",
  "data": {
    "current_page": 1,
    "per_page": 20,
    "total": 150,
    "last_page": 8,
    "from": 1,
    "to": 20,
    "data": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "organization_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "date_issue": "2023-12-25",
        "number": "OF-001/2024",
        "amount_total": "<string>",
        "precision": 123,
        "object_details": "<string>",
        "provider_company_name": "<string>",
        "company_name": "<string>",
        "company_name_short": "<string>",
        "status_id": 1,
        "status": "EMITIDA"
      }
    ]
  }
}

Query Parameters

​
organization_uuid
string<uuid>
required

UUID da organização

​
date_from
string<date>

Data inicial do filtro (YYYY-MM-DD). Deve ser usado em conjunto com date_to.

Example:

"2024-01-01"

​
date_to
string<date>

Data final do filtro (YYYY-MM-DD). Deve ser usado em conjunto com date_from.

Example:

"2024-12-31"

​
search
string

Busca textual no objeto e número do processo

​
year
integer

Filtro por ano do exercício

Example:

2024

​
per_page
integer
default:20

Número de registros por página. Mínimo: 1. Máximo: 100.

Required range: 1 <= x <= 100

Response

200 - application/json

Lista paginada de ordens de fornecimento

​
success
boolean
Example:

true

​
message
string
Example:

"Dados recuperados com sucesso"

​
data
object