v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Offices

Return a list of offices.

Returns a list of the existing offices in Kenjo.

get/offices

Query parameters

namestring
Example:Berlin office

The name of the office.

companyIdstring
Example:40a2db290da29e126a187895

The Kenjo id of the company.

calendarIdstring
Example:40a2db290da29e126a187895

The Kenjo id of the calendar.

streetstring
Example:Urbanstrasse, 71

The street of the office.

postalCodestring
Example:34213

The postal code of the office.

citystring
Example:Berlin

The city of the office.

countrystring
Example:DE

The country of the office in ISO code.

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK

_idstring

The Kenjo _id of the office.

namestring

The name of the office.

companyIdstring

The Kenjo id of the company.

calendarIdstring

The Kenjo id of the calendar.

streetstring

The street of the office.

postalCodestring

The postal code of the office.

citystring

The city of the office.

countrystring

The country of the office in ISO code.

Example response

[
  {
    "_id": "50a2db290da29e126a18789a",
    "name": "ACME Berlin",
    "companyId": "5b8555a97b62b223d27598c7",
    "calendarId": "5b8555a97b62b223d275a176",
    "street": "Urbanstr. 71",
    "postalCode": 10967,
    "city": "Berlin",
    "country": "DE"
  },
  {
    "_id": "50a2db290da29e126a18789b",
    "name": "ACME London",
    "companyId": "5b8555a97b62b223d27598c4",
    "calendarId": "5b8555a97b62b223d275a175",
    "street": "Park Street 20",
    "postalCode": 12342,
    "city": "London",
    "country": "GB"
  },
  {
    "_id": "50a2db290da29e126a18789c",
    "name": "ACME Madrid",
    "companyId": "5b8555a97b62b223d27598c6",
    "calendarId": "5b8555a97b62b223d275a177",
    "street": "Manuel Ferrero, 19",
    "postalCode": 28096,
    "city": "Madrid",
    "country": "ES"
  }
]