User Details

Returns the details of a single user.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

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

Required scope: users

Response

Success (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": null,
    "firstName": "Maria",
    "lastName": "Muster",
    "abbreviation": "MM",
    "sex": 1,
    "email": "maria.muster@example.com",
    "color": "#00adba",
    "sort": 0,
    "isBookable": true,
    "isDoctor": false,
    "showBookingWeeks": 4,
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique user ID
data.title	string | null	Title (e.g. "Dr.")
data.firstName	string | null	First name
data.lastName	string | null	Last name
data.abbreviation	string | null	Abbreviation
data.sex	integer | null	Sex (0 = male, 1 = female)
data.email	string | null	Email address
data.color	string | null	Color as hex code (e.g. #00adba)
data.sort	integer	Sort order
data.isBookable	boolean	Whether the user is bookable
data.isDoctor	boolean	Whether the user is marked as a doctor
data.showBookingWeeks	integer | null	Number of weeks displayed in the booking calendar
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

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/users/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 users not present
404	not_found	User not found