Tenant Details

Returns the details of a single tenant.

Request

GET /api/oauth/v2/resource/tenancies/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string (UUID)	Yes	Unique tenant ID

Required scope: company

Response

Success (200 OK)

{
  "data": {
    "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
    "name": "Ordination Muster",
    "abbreviation": "OM",
    "color": "#00adba"
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique tenant ID
data.name	string	Name of the tenant
data.abbreviation	string | null	Abbreviation
data.color	string | null	Color as hex code (e.g. #00adba)

Note: The API returns additional internal fields not documented here. Only use the fields described here — all others may change without notice.

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/tenancies/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *integer

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope company not present
404	not_found	Tenant not found