Form Details

Returns the metadata of a single form. The response contains no form answers and no recipient data.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique ID of the form

Response

Deleted and replaced forms are returned as well. You recognize a deleted form by deleted: true.

Success (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": "Anamnese",
    "customer": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
    "formCustomer": "b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e",
    "replacedBy": null,
    "presetEdition": null,
    "createdAt": "2026-06-10T09:15:00+02:00",
    "updatedAt": "2026-06-10T09:20:00+02:00",
    "createdBy": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",
    "updatedBy": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",
    "deleted": false,
    "deletedAt": null,
    "deletedBy": null
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique ID of the form
data.title	string	Title of the form
data.customer	string (UUID) | null	ID of the assigned customer
data.formCustomer	string (UUID) | null	ID of the related sent form, see Sent Form Details
data.replacedBy	string (UUID) | null	ID of the form that replaced this form
data.presetEdition	string | null	Edition of the form template the form comes from
data.createdAt	string | null	Created at (ISO 8601)
data.updatedAt	string | null	Last modified at (ISO 8601)
data.createdBy	string (UUID) | null	ID of the user who created the form
data.updatedBy	string (UUID) | null	ID of the user who last modified the form
data.deleted	boolean	true if the form was deleted
data.deletedAt	string | null	Deleted at (ISO 8601)
data.deletedBy	string (UUID) | null	ID of the user who deleted the form

Beispiele

bash

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

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope forms not present
403	access_denied	No read permission for forms, no forms license, or the form belongs to another company
404	not_found	Form not found or the assigned customer is outside the released tenants