Skip to main content
GET
/
api
/
v1
/
bko
/
reports
/
top-organizations
Get Top Organizations
curl --request GET \
  --url https://api.example.com/api/v1/bko/reports/top-organizations \
  --header 'Authorization: Bearer <token>'
[
  {
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "name": "Viação Estrela",
    "revenue": 3200000
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

Max organizations

Example:

5

​
range
string

Created at range

Example:

">=2024-01-01;<=2024-12-31"

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

​
organizationId
string<uuid>
required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

​
name
string
required

Organization name

Example:

"Viação Estrela"

​
revenue
integer
required

Revenue in cents

Example:

3200000