Sent Form Details

Returns the metadata of a single sent form. A sent form is a form that was sent to a customer or patient. The response contains no form answers and no recipient data.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	The id of the sent form

Note: It is not the link the recipient receives to fill out the form.

Response

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

Success (200 OK)

{
  "data": {
    "id": "b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e",
    "title": "Anamnese",
    "status": "completed",
    "customer": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
    "form": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "replacedBy": null,
    "presetEdition": null,
    "expiresAt": "2026-06-24T09:15:00+02:00",
    "submittedAt": "2026-06-11T18:02:00+02:00",
    "completedAt": "2026-06-12T08:30:00+02:00",
    "createdAt": "2026-06-10T09:15:00+02:00",
    "updatedAt": "2026-06-12T08:30: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)	Dedicated API UUID of the sent form
data.title	string	Title, matches the name of the form template
data.status	string	Status: open, in_progress, submitted, completed, or expired
data.customer	string (UUID) | null	ID of the customer the form was sent to
data.form	string (UUID) | null	ID of the related form, see Form Details
data.replacedBy	string (UUID) | null	ID of the sent form that replaced this one
data.presetEdition	string | null	Edition of the form template
data.expiresAt	string | null	Valid until (ISO 8601)
data.submittedAt	string | null	Submitted at (ISO 8601)
data.completedAt	string | null	Completed at (ISO 8601)
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 sent form
data.updatedBy	string (UUID) | null	ID of the user who last modified it
data.deleted	boolean	true if the sent form was deleted
data.deletedAt	string | null	Deleted at (ISO 8601)
data.deletedBy	string (UUID) | null	ID of the user who deleted it

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/forms/customers/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 sent form belongs to another company
404	not_found	Sent form not found or the assigned customer is outside the released tenants