Skip to main content
GET
/
api
/
v1
/
bko
/
organizations
List Organizations
curl --request GET \
  --url https://api.example.com/api/v1/bko/organizations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "document": "<string>",
      "logo": "<string>",
      "phoneIso": "<string>",
      "phoneDdi": "<string>",
      "phoneNumber": "<string>",
      "phoneVerified": true,
      "email": "<string>",
      "emailVerified": true,
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number
default:10

Items per page

Example:

10

​
page
number
default:1

Page number

Example:

1

​
types
string

Organization types. Comma-separated organization types.

Example:

"COOPERATIVE,COMPANY"

​
filter
string

Generic filter that matches against

  • name
  • document
Example:

"Viação"

​
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
name,
type,
createdAt
Example:

"createdAt"

​
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

​
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

​
data
object[]
required
​
meta
object
required

Pagination metadata