List agencies

Returns the regulatory agencies an order can name, with their job categories, ordered by code. Requires the agency.list scope.

GET /api/v2/agencies

List agencies

cURL

curl --request GET \
  --url https://api.stage.origin.one/api/v2/agencies \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "code": "FAA",
      "id": "3",
      "object": "agency",
      "name": "Federal Aviation Administration (FAA)",
      "jobCategories": [
        {
          "id": "3987402f-e963-45a9-8799-b9ea6621adae",
          "name": "Flight Crewmember",
          "object": "jobCategory",
          "url": "/api/v2/agencies/3/jobCategories/3987402f-e963-45a9-8799-b9ea6621adae"
        }
      ],
      "url": "/api/v2/agencies/3"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

Authorizations

Authorization · string · header · required

Origin One API token. Pass it in the Authorization header: Authorization: Bearer <token>.

Query Parameters

limit · integer · default: 10

Number of items per page (max 20).

Required range: 1 <= x <= 20

Example:

10

page · integer · default: 1

Page of results to return (1-based).

Required range: 1 <= x <= 10000

Example:

1

Response

200

application/json

Success.

data · object[] · required

Items on this page.

Show child attributes

limit · integer · required

Number of items per page.

Example:

10

page · integer · required

Current page number (1-based).

Example:

1

total · integer · required

Number of matching items across all pages.

Example:

1