Customer Details

Returns the details of a single customer.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique customer ID

Response

Success (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": null,
    "firstName": "Anna",
    "lastName": "Muster",
    "email": "anna.muster@example.com",
    "phone": "+43 664 1234567",
    "birthday": "1985-04-12",
    "socialNumber": "1234 120485",
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique customer ID
data.title	string | null	Title (e.g. Dr., Mag.)
data.firstName	string | null	First name
data.lastName	string | null	Last name
data.email	string | null	Email address
data.phone	string | null	Phone number
data.birthday	string | null	Date of birth (YYYY-MM-DD)
data.socialNumber	string | null	Social security number
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

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/customers/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 customers not present
404	not_found	Customer not found