Dokumentation

API-Referenz

GET/api/v1/signature-profiles/{signature_profile_id}

Signaturprofil abrufen

Liefert Absendername, Redirect-Ziel und Logostatus eines Profils. Erforderlich ist signature_profiles:read.

Beschreibung

Liefert ein einzelnes Signaturprofil.

Parameter

signature_profile_idpathPflicht

Öffentliche Signaturprofil-ID.

Beispiel: sgp_test_6f708192a3b4c5d6e7f8091a

Responses

200

Das Signaturprofil.

404

Profil fehlt oder gehört zu einem anderen Konto beziehungsweise einer anderen Umgebung.

Response-Body

Content-Type: application/json. Die erfolgreiche Antwort enthält die nachfolgend beschriebenen Felder.

Response-Felder

FeldTypAngabeBeschreibung
idstringImmerÖffentliche Signaturprofil-ID.
objectstringImmerKonstanter Wert signature_profile.
environmentenumImmertest oder live.
livemodebooleanImmertrue bei Produktivprofilen.
namestringOptionalInterne Bezeichnung.
display_namestringImmerAbsendername der Signaturanfrage.
redirect_urlstringOptionalRedirect-Ziel nach Abschluss der Signatur.
has_logobooleanImmerGibt an, ob ein Logo hinterlegt ist.
logo_urlstringOptionalRelativer Pfad der gespeicherten Logodatei.
created_atdate-timeImmerErstellungszeitpunkt.
updated_atdate-timeImmerLetzter Änderungszeitpunkt.
200 Response-Beispieljson
{
  "id": "sgp_test_6f708192a3b4c5d6e7f8091a",
  "object": "signature_profile",
  "environment": "test",
  "livemode": false,
  "name": "Standardprofil",
  "display_name": "Autohaus Beispiel GmbH",
  "redirect_url": "https://autohaus-beispiel.de/zulassung/abgeschlossen",
  "has_logo": false,
  "created_at": "2026-08-27T09:30:00+02:00",
  "updated_at": "2026-08-27T09:30:00+02:00"
}

Zum Öffnen eines Treffers Enter drücken.