List offices

This endpoint allows you to get a list of all offices of the given organization.

This endpoint requires offices_r or offices_rw scope.

offices list

GET https://www.welcomekit.co/api/v1/external/offices

Query Parameters

Name	Type	Description
organization_reference	string	Reference of the associated organization/company
per_page	integer	Number of jobs per page
page	integer	Page offset

200 Success

[
  {
    "id": 42,
    "name": "Paris",
    "address": "11 bis rue Bachaumont",
    "zip_code": "75002",
    "city": "Paris",
    "country_code": "FR",
    "is_headquarter": true
  }
]

Request example

curl -X GET -G "https://www.welcomekit.co/api/v1/external/offices" \
    -d "organization_reference=Pg4eV6k" \
    -H "Authorization: Bearer WK_API_KEY"