Versendetes Formular anzeigen

Gibt die Metadaten eines einzelnen versendeten Formulars zurück. Ein versendetes Formular ist ein Formular, das an einen Kunden oder Patienten verschickt wurde. Die Antwort enthält keine Formular-Antworten und keine Empfängerdaten.

Request

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

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string	Ja	Die id des versendeten Formulars

Hinweis: Sie ist nicht der Link, den der Empfänger zum Ausfüllen erhält.

Response

Gelöschte und ersetzte versendete Formulare werden ebenfalls geliefert. Ein gelöschtes Formular erkennst du an deleted: true.

Erfolg (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-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eigene API-UUID des versendeten Formulars
data.title	string	Titel, entspricht dem Namen der Formular-Vorlage
data.status	string	Status: open, in_progress, submitted, completed oder expired
data.customer	string (UUID) | null	ID des Kunden, an den das Formular versendet wurde
data.form	string (UUID) | null	ID des zugehörigen Formulars, siehe Formular anzeigen
data.replacedBy	string (UUID) | null	ID des versendeten Formulars, das dieses ersetzt hat
data.presetEdition	string | null	Auflage der Formular-Vorlage
data.expiresAt	string | null	Gültig bis (ISO 8601)
data.submittedAt	string | null	Abgesendet am (ISO 8601)
data.completedAt	string | null	Abgeschlossen am (ISO 8601)
data.createdAt	string | null	Erstellt am (ISO 8601)
data.updatedAt	string | null	Zuletzt geändert am (ISO 8601)
data.createdBy	string (UUID) | null	ID des Benutzers, der das versendete Formular erstellt hat
data.updatedBy	string (UUID) | null	ID des Benutzers, der es zuletzt geändert hat
data.deleted	boolean	true, wenn das versendete Formular gelöscht wurde
data.deletedAt	string | null	Gelöscht am (ISO 8601)
data.deletedBy	string (UUID) | null	ID des Benutzers, der es gelöscht hat

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

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope forms nicht vorhanden
403	access_denied	Keine Leseberechtigung für Formulare, keine Formular-Lizenz oder das versendete Formular gehört zu einem anderen Unternehmen
404	not_found	Versendetes Formular nicht gefunden oder der zugeordnete Kunde liegt außerhalb der freigegebenen Mandanten