Get an agency

Returns an agency with the job categories it publishes. Requires the agency.read scope.

GET /api/v2/agencies/{id}

Get an agency

cURL

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

200

{
  "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"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Unique identifier of the resource.

Example:

"123"

Response

200

application/json

Success.

code · string · required

Agency code, as regulations name it.

Example:

"FAA"

id · string · required

Unique identifier of the agency.

Example:

"3"

object · enum<string> · required

Object type; always agency.

Available options: agency

Example:

"agency"

name · string · required

Agency name.

Example:

"Federal Aviation Administration (FAA)"

jobCategories · object[] · required

Job categories the agency publishes, by name. An order names one when the agency has a choice.

Show child attributes

url · string<uri-reference> · required

Canonical path of this resource, relative to the API origin.

Example:

"/api/v2/agencies/3"