Retrieve an office

This endpoint allows you to get info about given office.

This endpoint requires offices_r or offices_rw scope.

office

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

Path Parameters

Name	Type	Description
id*	string	Office ID

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/:id" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WK_API_KEY"