Zum Inhalt springen

Organizations & Workspaces

Übersicht

qr3.app verwendet eine zweistufige Hierarchie:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Organisation — oberste Ebene, zugehörig zu einem Stripe-Konto und Plan
  • Workspace — isolierter Bereich für QR-Codes, Scans und API-Keys

Organizations API

GET /v1/organizations

Gibt die Organisation zurück, zu der der aktuelle API-Key gehört.

Terminal-Fenster
curl https://qr3.app/v1/organizations \
-H "Authorization: Bearer qr3_sk_..."

POST /v1/organizations

Erstellt eine neue Organisation.

Terminal-Fenster
curl -X POST https://qr3.app/v1/organizations \
-H "Authorization: Bearer qr3_sk_..." \
-H "Content-Type: application/json" \
-d '{
"name": "Digital Heroes GmbH",
"slug": "digital-heroes",
"billing_email": "[email protected]"
}'

Felder:

FeldTypPflichtBeschreibung
namestringAnzeigename (max. 255 Zeichen)
slugstringURL-freundlich, einzigartig (min. 2, max. 63 Zeichen, nur a-z0-9-)
billing_emailstringRechnungs-E-Mail

PATCH /v1/organizations/:id

Terminal-Fenster
curl -X PATCH https://qr3.app/v1/organizations/org_a1b2c3 \
-H "Authorization: Bearer qr3_sk_..." \
-H "Content-Type: application/json" \
-d '{ "name": "Digital Heroes AG", "billing_email": "[email protected]" }'

DELETE /v1/organizations/:id

Soft-Delete der Organisation. Alle zugehörigen Workspaces und QR-Codes bleiben erhalten, sind aber nicht mehr zugänglich.


Workspaces API

GET /v1/workspaces

Alle Workspaces der Organisation auflisten.

Terminal-Fenster
curl https://qr3.app/v1/workspaces \
-H "Authorization: Bearer qr3_sk_..."

POST /v1/workspaces

Neuen Workspace erstellen.

Terminal-Fenster
curl -X POST https://qr3.app/v1/workspaces \
-H "Authorization: Bearer qr3_sk_..." \
-H "Content-Type: application/json" \
-d '{
"name": "Kunde Bäckerei Schmidt",
"slug": "baeckerei-schmidt",
"default_locale": "de",
"primary_color": "#8B4513",
"approval_required": false
}'

Felder:

FeldTypStandardBeschreibung
namestringAnzeigename (Pflicht)
slugstringURL-freundlich, einzigartig pro Org (Pflicht)
default_localestringdeStandardsprache
approval_requiredbooleanfalseFreigabe-Workflow aktivieren
primary_colorstringBranding-Farbe (#RRGGBB)

Plan-Limits:

PlanMax. Workspaces
Free1
Pro3
Business10
AgencyUnbegrenzt

PATCH /v1/workspaces/:id

Terminal-Fenster
curl -X PATCH https://qr3.app/v1/workspaces/ws_xyz789 \
-H "Authorization: Bearer qr3_sk_..." \
-H "Content-Type: application/json" \
-d '{
"name": "Neuer Name",
"approval_required": true,
"custom_domain": "qr.baeckerei-schmidt.de"
}'

DELETE /v1/workspaces/:id

Archiviert den Workspace. Kann nicht auf den eigenen Workspace angewendet werden.


Audit-Logs

GET /v1/audit-logs

Nachvollziehbares Protokoll aller Änderungen im Workspace.

Terminal-Fenster
curl "https://qr3.app/v1/audit-logs?resource_type=codes&limit=50" \
-H "Authorization: Bearer qr3_sk_..."

Query-Parameter:

ParameterTypBeschreibung
resource_typestringFilter nach Ressource: codes, api_keys, webhooks, workspaces
resource_idstringFilter nach spezifischer Ressource-ID
actionstringFilter nach Aktion (z.B. codes.created)
cursorstringPagination-Cursor
limitintegerMax. 100 (Standard: 50)

Beispiel-Response:

{
"data": [
{
"id": "aud_a1b2c3",
"actor_type": "api",
"action": "codes.created",
"resource_type": "codes",
"resource_id": "qr_xyz123",
"changes": {},
"created_at": "2026-03-15T10:00:00.000Z"
}
]
}