List Locations

Returns a paginated list of all locations.

Request

GET /api/oauth/v2/resource/locations

Header

Header	Value
Authorization	Bearer {access_token}

Query parameters

Parameter	Type	Required	Description
offset	integer	No	Start position (default: 0)
limit	integer	No	Number of results (default: 50, max: 200)
view	string	No	default (default value) or slim for the slim response

Required scope: locations

Response

Success (200 OK)

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
      "name": "Hauptordination Wien",
      "bookingName": "Wien – 1. Bezirk",
      "abbreviation": "WI1",
      "street": "Musterstraße 1",
      "zip": "1010",
      "city": "Wien",
      "country": "AT",
      "description": "Barrierefrei zugänglich",
      "color": "#74AFAD",
      "email": "wien@example.com",
      "tel": "1234567",
      "telCode": "+43",
      "lat": 48.2082,
      "lng": 16.3738,
      "sort": 0,
      "bookable": true,
      "tenancies": [
        {
          "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
          "name": "Ordination Muster",
          "abbreviation": "OM",
          "color": "#00adba"
        }
      ]
    }
  ],
  "meta": {
    "total": 3,
    "offset": 0,
    "limit": 50
  }
}

Response fields

Field	Type	Description
data	Array	List of locations
data[].id	string (UUID)	Unique location ID
data[].name	string	Internal name of the location
data[].bookingName	string | null	Display name for booking
data[].abbreviation	string | null	Abbreviation
data[].street	string | null	Street and house number
data[].zip	string | null	Postal code
data[].city	string | null	City
data[].country	string | null	Country code (ISO 3166-1 alpha-2)
data[].description	string | null	Description text
data[].color	string	Color as hex code (e.g. #74AFAD)
data[].email	string | null	Email address of the location
data[].tel	string | null	Phone number
data[].telCode	string | null	Dialing code
data[].lat	number | null	Latitude
data[].lng	number | null	Longitude
data[].sort	integer	Sort order
data[].bookable	boolean	Whether the location is bookable
data[].tenancies	Array	Assigned tenants
data[].tenancies[].id	string (UUID)	Tenant ID
data[].tenancies[].name	string	Name of the tenant
data[].tenancies[].abbreviation	string	Abbreviation
data[].tenancies[].color	string	Color as hex code
meta.total	integer	Total number of locations
meta.offset	integer	Current start position
meta.limit	integer	Number of returned entries

Note: The id is returned as a UUID and is required for querying available slots and booking appointments.

Slim response (?view=slim)

With ?view=slim, the endpoint returns only the most important fields per location. Without the parameter, the response stays unchanged — existing integrations don't need to change anything.

If view is given more than once, the last value wins — ?view=default&view=slim returns the slim response.

The slim response omits contact details (email, tel, telCode), geo coordinates (lat, lng), bookingName, color, description, and the tenant assignment (tenancies).

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
      "name": "Hauptordination Wien",
      "abbreviation": "WI1",
      "street": "Musterstraße 1",
      "zip": "1010",
      "city": "Wien",
      "country": "AT",
      "bookable": true,
      "sort": 0
    }
  ],
  "meta": {
    "total": 3,
    "offset": 0,
    "limit": 50
  }
}

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/locations?offset=0&limit=50&view=default" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

offset integer

limit integer

view string

Zuerst Token anfordern

Possible errors

Status	Code	Description
400	validation_error	Invalid value for view
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope locations not present