API-Dokumentation

Mit der Snipzr-API erstellst, verwaltest und misst du Kurzlinks aus deinem eigenen Code. Es ist eine schlichte HTTPS-plus-JSON-API: Alle Endpunkte unten liegen unter https://api.snipzr.com/v1, nehmen JSON an, geben JSON zurück und authentifizieren sich mit einem Bearer-Token.

Die API ist in jedem bezahlten Plan enthalten (Pro, Team und höher). Die Preisseite ist die verbindliche Quelle für Plan-Limits.

Authentifizierung

Sende dein Token im Authorization-Header jeder Anfrage:

Authorization: Bearer DEIN_TOKEN

Es gibt zwei Arten von Token. Beide funktionieren an jedem Endpunkt; sie unterscheiden sich darin, als was sie handeln.

Workspace-Tokens (empfohlen)

Ein Workspace-Token handelt als der Workspace, in dem es erstellt wurde, mit dessen Plan-Limits. Links, die es erstellt, gehören dem Workspace; Statistiken und Kampagnenberichte beziehen sich auf den Workspace; GET /zones listet die Domains des Workspace.

Erstelle eines in den Einstellungen in der Karte API-Tokens, als Owner oder Admin eines bezahlten Workspace. Gib ihm einen Namen (zum Beispiel ci-deploy oder kunde-acme-report).
Das Secret beginnt mit snz_ws_ und wird einmal angezeigt, bei der Erstellung. Lege es in deinem Secret-Manager ab; falls es verloren geht, widerrufe es und erstelle ein neues.
Ein widerrufenes Token wird sofort abgelehnt. In der Liste bleiben nur die letzten vier Zeichen sichtbar, damit du Tokens unterscheiden kannst.
Alle Tokens eines Workspace teilen sich dessen Ratenlimit (siehe unten).

Persönliches Token

Wenn du Snipzr ohne einen erstellten Workspace nutzt, hat dein Konto ein persönliches Token unter Einstellungen → API-Zugriff (angezeigt als Client Secret). Es handelt auf deinem persönlichen Workspace. Neu generieren ersetzt das alte Secret sofort.

Plan-Voraussetzung

Tokens funktionieren nur, solange der Workspace (oder das Konto) einen bezahlten Plan hat. Im Free-Plan antwortet jede Anfrage mit 401 und API tokens are only available to premium workspaces. Vorhandene Tokens bleiben erhalten und funktionieren nach einem Upgrade wieder.

Konventionen

Basis-URL: https://api.snipzr.com/v1. Sende Content-Type: application/json bei POST und PATCH.
Fehler sind JSON: { "error": "lesbare Meldung" }. Manche Fehler tragen zusätzlich ein stabiles Feld code (zum Beispiel CAMPAIGN_REPORT_NOT_IN_PLAN). Meldungen sind standardmäßig Englisch; mit Accept-Language: de erhältst du Deutsch.
Zeitstempel (createdAt, updatedAt) sind ISO 8601 in UTC. Analyse-Zeiträume verwenden UTC-Kalenderdaten, YYYY-MM-DD.
Additive Änderungen. Neue Felder können ohne Versionswechsel in Antworten erscheinen, und manche Felder erscheinen nur, wenn sie zutreffen (unten markiert). Ignoriere Felder, die du nicht kennst.
Slugs bestehen aus 3 bis 1024 Zeichen aus A-Z a-z 0-9 - _ und sind innerhalb einer Domain eindeutig. Verwendest du einen Slug auf zwei deiner Domains, gib den Slug-Endpunkten (GET, PATCH, DELETE und /stats auf /urls/:slug) mit ?zoneDomain= an, welchen du meinst; ohne Angabe wirken sie auf den ersten Treffer.

Ratenlimits

Ein Kontingent gilt für alle /v1-Endpunkte zusammen, pro Minute:

Plan	Anfragen pro Minute
Pro	300
Team	600

Anfragen mit Workspace-Tokens zählen auf das Kontingent des Workspace, egal wie viele Tokens er hat; ein persönliches Token hat sein eigenes. Über dem Limit antwortet die API mit 429 und einem Retry-After-Header (in Sekunden). Warte diese Zeit ab und wiederhole die Anfrage dann. Ein Stapel mit bis zu 100 Links zählt als eine Anfrage; Migrationen sollten daher POST /urls/batch verwenden. GET /usage zeigt dein Kontingent.

Erste Schritte

Token erstellen in den Einstellungen (siehe oben).
Funktion prüfen mit GET /zones. Es liefert die Domains, auf denen du Links erstellen kannst.
Link erstellen mit POST /urls, oder viele auf einmal mit POST /urls/batch.
Zahlen lesen mit GET /urls/:slug/stats oder, für UTM-getaggte Links, GET /urls/campaigns. GET /usage zeigt, wie viel vom Plan-Kontingent noch frei ist.

Endpunkte

POST /urls

Erstellt einen Kurzlink.

API-Endpunkt:

POST https://api.snipzr.com/v1/urls

Request Body

Parameter	Typ	Beschreibung
`url`	string	Das Ziel. Erforderlich; `http` oder `https`; bis zu 32.767 Zeichen.
`title`	string	Optionale Bezeichnung, bis zu 256 Zeichen.
`slug`	string	Optionaler eigener Slug (3 bis 1024 Zeichen aus Buchstaben, Zahlen, Bindestrichen, Unterstrichen). Ohne Angabe wird ein Slug generiert. Reservierte Wörter wie `login` werden abgelehnt.
`zoneDomain`	string	Optionale Domain für den Link, zum Beispiel `snipzr.com` oder eine deiner verbundenen Domains. Ohne Angabe wird deine Standard-Domain verwendet. `GET /zones` zeigt die Auswahl.

Trägt das Ziel UTM-Parameter, leitet Snipzr daraus ein utm-Objekt ab und liefert es in jeder Antwort zu diesem Link mit.

Antwort `201`

{
  "url": {
    "id": "6a957857666cec1016ee2248",
    "slug": "fruehjahrs-aktion",
    "url": "https://example.com/aktion?utm_source=newsletter&utm_medium=email&utm_campaign=fruehjahr",
    "title": "Frühjahrsaktion",
    "zoneDomain": "snipzr.com",
    "hits": 0,
    "isEnabled": true,
    "createdAt": "2026-08-31T12:49:27.444Z",
    "updatedAt": "2026-08-31T12:49:27.444Z",
    "utm": { "source": "newsletter", "medium": "email", "campaign": "fruehjahr" }
  }
}

Fehler: 400 ungültige URL oder ungültiger Slug, 403 Link-Kontingent des Plans aufgebraucht (INSUFFICIENT_QUOTA), 409 Slug existiert auf dieser Domain bereits.

cURL-Befehl

curl -X POST https://api.snipzr.com/v1/urls \
-H "Authorization: Bearer DEIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "url": "https://example.com/aktion",
  "title": "Frühjahrsaktion",
  "slug": "fruehjahrs-aktion",
  "zoneDomain": "snipzr.com"
}'

POST /urls/batch

Erstellt bis zu 100 Links in einer Anfrage. Gedacht für Migrationen und Importe: Ein Stapel zählt als eine einzige Anfrage auf dein Ratenlimit, und jeder Eintrag wird für sich verarbeitet, sodass eine fehlerhafte Zeile nie den Rest scheitern lässt.

API-Endpunkt:

POST https://api.snipzr.com/v1/urls/batch

Request Body

{
  "links": [
    { "url": "https://example.com/bericht", "title": "Frühjahrsbericht", "slug": "fruehjahrsbericht", "zoneDomain": "snipzr.com" },
    { "url": "https://example.com/einfach" }
  ]
}

Jeder Eintrag nimmt dieselben Felder wie POST /urls. Zwischen 1 und 100 Einträge; der Request Body darf höchstens 1 MB groß sein.

Antwort `200`

Ein verarbeiteter Stapel antwortet immer mit 200. Lies results, um zu erfahren, was mit jedem Eintrag geschehen ist: Die Liste hat dieselbe Reihenfolge wie links, und jeder Eintrag trägt entweder den erstellten Link oder Status, Code und Meldung, die der Einzel-Endpunkt geliefert hätte.

{
  "created": 2,
  "failed": 2,
  "results": [
    { "index": 0, "status": 201, "url": { "id": "6a957b5c7c364cb08068e031", "slug": "fruehjahrsbericht", "url": "https://example.com/bericht", "title": "Frühjahrsbericht", "zoneDomain": "snipzr.com", "hits": 0, "isEnabled": true, "createdAt": "2026-08-31T13:20:11.102Z", "updatedAt": "2026-08-31T13:20:11.102Z" } },
    { "index": 1, "status": 201, "url": { "id": "6a957b5c7c364cb08068e032", "slug": "k3x9q", "url": "https://example.com/einfach", "title": "", "zoneDomain": "snipzr.com", "hits": 0, "isEnabled": true, "createdAt": "2026-08-31T13:20:11.140Z", "updatedAt": "2026-08-31T13:20:11.140Z" } },
    { "index": 2, "status": 400, "code": "VALIDATION_FAILED", "error": "URL must be a valid HTTP or HTTPS URL" },
    { "index": 3, "status": 409, "code": "SLUG_EXISTS", "error": "Slug already exists" }
  ]
}

Codes, die dir begegnen: VALIDATION_FAILED (400), SLUG_EXISTS (409), SLUG_RESERVED und SLUG_INVALID (400), INSUFFICIENT_QUOTA (403). Ist das Link-Kontingent des Plans aufgebraucht, scheitern alle weiteren Einträge mit INSUFFICIENT_QUOTA, ohne versucht zu werden; prüfe vor einem großen Import GET /usage.

Fehler am Umschlag ergeben 400 mit einem einfachen error: keine Einträge, mehr als 100 Einträge oder ein Body, der kein JSON ist.

cURL-Befehl

curl -X POST https://api.snipzr.com/v1/urls/batch \
-H "Authorization: Bearer DEIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "links": [
    { "url": "https://example.com/bericht", "title": "Frühjahrsbericht", "slug": "fruehjahrsbericht" },
    { "url": "https://example.com/einfach" }
  ]
}'

PATCH /urls/:slug

Ändert einen Kurzlink. Sende nur die Felder, die sich ändern sollen.

API-Endpunkt:

PATCH https://api.snipzr.com/v1/urls/:slug

Request Body

Parameter	Typ	Beschreibung
`url`	string	Neues Ziel (`http` oder `https`, bis zu 32.767 Zeichen). Das `utm`-Objekt wird daraus neu abgeleitet.
`title`	string	Neuer Titel, bis zu 256 Zeichen.
`newSlug`	string	Neuer Slug (gleiche Regeln wie beim Erstellen).
`isEnabled`	boolean	`false` pausiert den Link (er leitet nicht mehr weiter), `true` aktiviert ihn wieder.

Der optionale Query-Parameter zoneDomain wählt die Domain, wenn der Slug auf mehreren existiert. Änderungen werden nie gezählt: Ändere das Ziel so oft du möchtest, in jedem Plan.

Antwort `200`

Liefert { "url": { ... } } mit dem aktualisierten URL-Objekt.

Fehler: 400 ungültiger Wert oder Slug, 404 kein solcher Link in diesem Workspace, 409 newSlug existiert auf dieser Domain bereits.

cURL-Befehl

curl -X PATCH https://api.snipzr.com/v1/urls/fruehjahrs-aktion \
-H "Authorization: Bearer DEIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "url": "https://example.com/aktion-2026",
  "title": "Frühjahrsaktion 2026",
  "isEnabled": true
}'

GET /urls

Listet die Links des Workspace, neueste zuerst, mit Paginierung.

API-Endpunkt:

GET https://api.snipzr.com/v1/urls?page=1&limit=10

Query-Parameter

Parameter	Typ	Beschreibung
`page`	number	Seitennummer, beginnend bei 1 (Standard: 1).
`limit`	number	Links pro Seite (Standard: 10, Maximum: 100). Ein größerer Wert ergibt `400`.
`zoneDomain`	string	Nur Links auf dieser Domain.
`q`	string	Nur Links, deren Slug, Titel oder Ziel diesen Text enthält (Groß-/Kleinschreibung egal, wörtlich; bis zu 200 Zeichen). Praktisch, um einen vorhandenen Link über sein Ziel zu finden, statt ein Duplikat anzulegen.
`campaign`	string	Nur Links, deren abgeleitetes `utm.campaign` diesem Wert entspricht.

Filter lassen sich kombinieren; total bezieht sich auf die gefilterte Menge.

Antwort `200`

{
  "urls": [
    {
      "id": "6a957857666cec1016ee2248",
      "slug": "fruehjahrs-aktion",
      "url": "https://example.com/aktion",
      "title": "Frühjahrsaktion",
      "zoneDomain": "snipzr.com",
      "hits": 1284,
      "isEnabled": true,
      "createdAt": "2026-08-31T12:49:27.444Z",
      "updatedAt": "2026-08-31T12:49:27.444Z"
    }
  ],
  "total": 42
}

total ist die Anzahl der Links im Workspace, damit du die Seitenzahl berechnen kannst. In Team-Workspaces mit aktivierten UTM-Konventionen trägt ein Link, dessen Ziel diese Konventionen verletzt, "utmDrift": true; sonst fehlt das Feld.

cURL-Befehl

curl "https://api.snipzr.com/v1/urls?page=1&limit=50" \
-H "Authorization: Bearer DEIN_TOKEN"

GET /urls/:slug

Liefert einen Link anhand seines Slugs.

API-Endpunkt:

GET https://api.snipzr.com/v1/urls/:slug

Antwort `200`

{
  "url": {
    "id": "6a957857666cec1016ee2248",
    "slug": "fruehjahrs-aktion",
    "url": "https://example.com/aktion?utm_source=newsletter&utm_medium=email&utm_campaign=fruehjahr",
    "title": "Frühjahrsaktion",
    "zoneDomain": "snipzr.com",
    "hits": 1284,
    "isEnabled": true,
    "createdAt": "2026-08-31T12:49:27.444Z",
    "updatedAt": "2026-08-31T12:49:27.444Z",
    "utm": { "source": "newsletter", "medium": "email", "campaign": "fruehjahr" }
  }
}

Der optionale Query-Parameter zoneDomain wählt die Domain, wenn der Slug auf mehreren existiert. Fehler: 400 fehlerhafter Slug, 404 kein solcher Link in diesem Workspace (oder nicht auf dieser Domain).

cURL-Befehl

curl "https://api.snipzr.com/v1/urls/fruehjahrs-aktion?zoneDomain=snipzr.com" \
-H "Authorization: Bearer DEIN_TOKEN"

GET /urls/:slug/stats

Voraggregierte Analysen für einen Link: Klicks pro Tag, Menschen vs. automatisierter Traffic mit Gründen, Länder, Verweise, Geräte und die Aufteilung QR vs. Link. Cookielos und nur aggregiert (keine Zeilen pro Klick, keine Besucherkennungen). Das vollständige Antwortschema, die Zeitraum- und Aufbewahrungssemantik sowie die Aktualität beschreibt die Link-Statistik-API.

API-Endpunkt:

GET https://api.snipzr.com/v1/urls/:slug/stats?from=YYYY-MM-DD&to=YYYY-MM-DD

from und to sind optionale UTC-Daten (Standard: die letzten 30 Tage). Ein Zeitraum über der Analyse-Aufbewahrung deines Plans wird begrenzt, nicht abgelehnt; der effektive Anfang steht in range.clampedTo. from nach to ergibt 400; ein unbekannter Slug 404. zoneDomain wählt die Domain, wenn der Slug auf mehreren existiert.

cURL-Befehl

curl "https://api.snipzr.com/v1/urls/fruehjahrs-aktion/stats?from=2026-08-01&to=2026-08-31" \
-H "Authorization: Bearer DEIN_TOKEN"

GET /urls/campaigns

Der Kampagnenbericht des Workspace: jede Kampagne aus den UTM-Tags deiner Links, mit Link-Anzahl, menschlichen Klicks, QR-Scans, einer Tagesreihe sowie einer Aufschlüsselung nach Quelle und Medium. Das ist der Endpunkt hinter der Kampagnen-Seite in der App, verfügbar für automatisiertes Reporting (zum Beispiel das Berichts-Skript einer Agentur pro Kunde).

Verfügbar ab Pro. Workspace-Tokens berichten über ihren Workspace; ein persönliches Token über deine persönlichen Links.

API-Endpunkt:

GET https://api.snipzr.com/v1/urls/campaigns?from=YYYY-MM-DD&to=YYYY-MM-DD

from und to sind optionale UTC-Daten (Standard: die letzten 30 Tage). Wie bei den Link-Statistiken wird ein Zeitraum über der Analyse-Aufbewahrung deines Plans begrenzt, nicht abgelehnt.

Antwort `200`

{
  "report": {
    "range": { "from": "2026-08-01", "to": "2026-08-31", "clampedTo": "2026-08-01", "retentionDays": 730 },
    "teaser": false,
    "totalCampaigns": 5,
    "taggedLinks": 6,
    "campaigns": [
      {
        "campaign": "fruehjahr",
        "linkCount": 2,
        "humanClicks": 1582,
        "qrScans": 201,
        "series": [{ "date": "2026-08-02", "human": 41 }],
        "drill": [{ "source": "newsletter", "medium": "email", "linkCount": 2, "humanClicks": 1582 }]
      }
    ],
    "freshness": "todayLive"
  }
}

campaigns entfällt, wenn im Zeitraum keine UTM-getaggten Links existieren. Ein Plan ohne Kampagnenberichte erhält 403 mit "code": "CAMPAIGN_REPORT_NOT_IN_PLAN".

cURL-Befehl

curl "https://api.snipzr.com/v1/urls/campaigns?from=2026-08-01&to=2026-08-31" \
-H "Authorization: Bearer DEIN_TOKEN"

DELETE /urls/:slug

Löscht einen Link dauerhaft. Die Kurz-URL leitet sofort nicht mehr weiter, und ihre Analysen werden entfernt.

API-Endpunkt:

DELETE https://api.snipzr.com/v1/urls/:slug

Antwort `200`

{
  "message": "URL erfolgreich gelöscht"
}

Der optionale Query-Parameter zoneDomain löscht nur den Link auf dieser Domain. Fehler: 400 fehlerhafter Slug, 404 kein solcher Link in diesem Workspace, 403 der Link wurde von Snipzr eingeschränkt und kann vom Eigentümer nicht gelöscht werden.

cURL-Befehl

curl -X DELETE https://api.snipzr.com/v1/urls/fruehjahrs-aktion \
-H "Authorization: Bearer DEIN_TOKEN"

GET /usage

Der Plan des Workspace, wie viel vom Link-Kontingent dieser Periode verbraucht ist, der Zähler der erfassten Ereignisse sowie die API- und Analyse-Berechtigungen. Lies ihn vor einem Import, um deine Stapel zu bemessen, oder um das Kontingent in deinen eigenen Werkzeugen anzuzeigen.

API-Endpunkt:

GET https://api.snipzr.com/v1/usage

Antwort `200`

{
  "usage": {
    "plan": "team",
    "links": { "used": 412, "limit": 5000, "remaining": 4588, "periodStart": "2026-08-15T09:12:00Z", "periodEnd": "2026-09-15T09:12:00Z" },
    "events": { "used": 18230, "limit": 100000, "periodStart": "2026-08-15T09:12:00Z", "periodEnd": "2026-09-15T09:12:00Z", "locked": false },
    "api": { "requestsPerMinute": 600, "batchMaxLinks": 100 },
    "analytics": { "retentionDays": 730, "campaignReports": true }
  }
}

links ist das Kontingent neuer Links der laufenden Abrechnungsperiode (Jahrespläne tragen den Pool des ganzen Jahres). events ist der Zähler erfasster menschlicher Ereignisse; locked ist true, solange der Zähler über seinem Kontingent liegt. events entfällt, falls der Zähler kurzzeitig nicht verfügbar ist; alles andere ist immer vorhanden.

cURL-Befehl

curl https://api.snipzr.com/v1/usage \
-H "Authorization: Bearer DEIN_TOKEN"

GET /zones

Die Domains, auf denen du Links erstellen kannst: die gemeinsamen Snipzr-Domains (global) und die mit dem Workspace verbundenen eigenen Domains (user). Verwende einen domain-Wert als zoneDomain beim Erstellen eines Links.

API-Endpunkt:

GET https://api.snipzr.com/v1/zones

Antwort `200`

{
  "global": [
    {
      "domain": "snipzr.com",
      "name": "Snipzr",
      "zoneType": "global",
      "isEnabled": true,
      "isDefault": true
    }
  ],
  "user": [
    {
      "domain": "go.example.com",
      "name": "Example Kurzlinks",
      "zoneType": "user",
      "isEnabled": true,
      "isDefault": false,
      "tlsState": "provisioned",
      "ownershipState": "verified",
      "rootRedirectURL": "https://example.com"
    }
  ]
}

Von den gemeinsamen Domains werden nur aktive gelistet; deine eigenen Domains erscheinen auch deaktiviert, damit du ihren Zustand siehst. Links auf einer eigenen Domain sind möglich, sobald ownershipState gleich verified und die Domain aktiviert ist.

cURL-Befehl

curl https://api.snipzr.com/v1/zones \
-H "Authorization: Bearer DEIN_TOKEN"

QR-Codes

Es gibt keinen QR-Endpunkt, weil du keinen brauchst. Jeder Kurzlink hat eine Scan-URL:

https://<zoneDomain>/q/<slug>

Kodiere diese URL mit einer beliebigen QR-Bibliothek (oder über den Download in der App, der dieselbe URL verwendet). Sie leitet genauso weiter wie https://<zoneDomain>/<slug>, und wegen des Pfads /q/ zählt Snipzr den Besuch als Scan statt als Klick: Er erscheint als source.qr in GET /urls/:slug/stats und als qrScans in GET /urls/campaigns. Drucke die /q/-Form; teile die einfache Form.

Antwort-Referenz

HTTP-Statuscodes

Status	Bedeutung
`200`	Erfolg (auch ein verarbeiteter Stapel; die Ergebnisse je Eintrag stehen in `results`)
`201`	Erstellt (`POST /urls`)
`400`	Ungültige Anfrage: Validierung fehlgeschlagen (ungültige URL, Slug, Zeitraum oder Seitengröße). Das Feld `error` nennt den Grund.
`401`	Fehlendes oder ungültiges Token, oder der Workspace ist im Free-Plan
`403`	Nicht im Plan enthalten (Link-Kontingent aufgebraucht, Kampagnenberichte) oder der Link ist eingeschränkt
`404`	Kein solcher Link in diesem Workspace
`409`	Der Slug existiert auf dieser Domain bereits
`423`	Der Workspace schließt gerade eine Eigentumsübertragung ab; nach den `Retry-After`-Sekunden erneut versuchen (nur Schreibzugriffe)
`429`	Ratenlimit überschritten; nach den `Retry-After`-Sekunden erneut versuchen
`500`	Auf unserer Seite ist etwas fehlgeschlagen. Mit Backoff wiederholen; wir werden automatisch benachrichtigt
`503`	Analysespeicher nicht verfügbar und keine Live-Daten decken den Zeitraum ab (nur `stats`)

URL-Objekt

Feld	Typ	Beschreibung
`id`	string	Eindeutige Kennung des Links
`slug`	string	Der Kurz-URL-Pfad (zum Beispiel `fruehjahrs-aktion`)
`url`	string	Das Ziel, zu dem der Kurzlink weiterleitet
`title`	string	Optionale Bezeichnung; leerer String, wenn nicht gesetzt
`zoneDomain`	string	Die Domain des Kurzlinks (zum Beispiel `snipzr.com`)
`hits`	number	Weiterleitungen des Links insgesamt, inklusive Bots. Menschliche Klicks liefert `GET /urls/:slug/stats`
`isEnabled`	boolean	`true`, solange der Link weiterleitet, `false` während er pausiert ist
`createdAt`	string	ISO-8601-Zeitstempel der Erstellung (UTC)
`updatedAt`	string	ISO-8601-Zeitstempel der letzten Änderung (UTC)
`utm`	object	Aus dem Ziel abgeleitete UTM-Parameter (`source`, `medium`, `campaign`, `term`, `content`, jeweils nur wenn vorhanden). Nur wenn das Ziel UTM-Parameter trägt
`utmDrift`	boolean	`true`, wenn das Ziel die UTM-Konventionen des Workspace verletzt (Team). Nur in `GET /urls`, nur wenn zutreffend
`isRestricted`	boolean	`true`, wenn Snipzr den Link nach seiner Missbrauchsrichtlinie eingeschränkt hat. Nur wenn true
`isUnsafe`	boolean	`true`, wenn das Ziel aktuell als unsicher markiert ist (Phishing, Malware). Nur wenn true

Zonen-Objekt

Feld	Typ	Beschreibung
`domain`	string	Der Domainname (zum Beispiel `snipzr.com`)
`name`	string	Anzeigename der Domain
`zoneType`	string	`global` (gemeinsame Snipzr-Domain) oder `user` (deine eigene Domain)
`isEnabled`	boolean	Ob die Domain aktuell Links ausliefert
`isDefault`	boolean	Ob sie die Standard-Domain für neue Links ist, wenn `zoneDomain` fehlt
`tlsState`	string	Zertifikatsstatus, zum Beispiel `provisioned` (nur eigene Domains)
`ownershipState`	string	Status der Domain-Verifizierung, zum Beispiel `verified` (nur eigene Domains)
`rootRedirectURL`	string	Wohin die nackte Domain weiterleitet; leerer String, wenn nicht gesetzt (nur eigene Domains)

Support

Benötigst du Hilfe mit der API?

Authentifizierung​

Workspace-Tokens (empfohlen)​

Persönliches Token​

Plan-Voraussetzung​

Konventionen​

Ratenlimits​

Erste Schritte​

Endpunkte​

POST /urls​

Request Body​

Antwort 201​

cURL-Befehl​

POST /urls/batch​

Request Body​

Antwort 200​

cURL-Befehl​

PATCH /urls/:slug​

Request Body​

Antwort 200​

cURL-Befehl​

GET /urls​

Query-Parameter​

Antwort 200​

cURL-Befehl​

GET /urls/:slug​

Antwort 200​

cURL-Befehl​

GET /urls/:slug/stats​

cURL-Befehl​

GET /urls/campaigns​

Antwort 200​

cURL-Befehl​

DELETE /urls/:slug​

Antwort 200​

cURL-Befehl​

GET /usage​

Antwort 200​

cURL-Befehl​

GET /zones​

Antwort 200​

cURL-Befehl​

QR-Codes​

Antwort-Referenz​

HTTP-Statuscodes​

URL-Objekt​

Zonen-Objekt​

Support​

Authentifizierung

Workspace-Tokens (empfohlen)

Persönliches Token

Plan-Voraussetzung

Konventionen

Ratenlimits

Erste Schritte

Endpunkte

POST /urls

Request Body

Antwort `201`

cURL-Befehl

POST /urls/batch

Request Body

Antwort `200`

cURL-Befehl

PATCH /urls/:slug

Request Body

Antwort `200`

cURL-Befehl

GET /urls

Query-Parameter

Antwort `200`

cURL-Befehl

GET /urls/:slug

Antwort `200`

cURL-Befehl

GET /urls/:slug/stats

cURL-Befehl

GET /urls/campaigns

Antwort `200`

cURL-Befehl

DELETE /urls/:slug

Antwort `200`

cURL-Befehl

GET /usage

Antwort `200`

cURL-Befehl

GET /zones

Antwort `200`

cURL-Befehl

QR-Codes

Antwort-Referenz

HTTP-Statuscodes

URL-Objekt

Zonen-Objekt

Support