Zum Inhalt springen
Sursa Developers

GET/v1/folders

Ordnerbäume aller Sammlungen abrufen

folder_trees

Gibt in einer Antwort die Ordnerbäume aller Sammlungen zurück, in denen der Benutzer mindestens ein Objekt sehen kann, mit denselben Sichtbarkeitsregeln wie GET /v1/collections/{name}/folders und in der Reihenfolge von GET /v1/collections. Eine Sammlung ohne sichtbare Objekte wird ausgelassen. Neben cards enthält jeder Ordner die Summen über den Teilbaum cards_total, sensitive_total und top_category. Mit updated_since oder metadata[<key>]= enthalten die folders jeder Sammlung die passenden Ordner als flache Liste (children ist leer, und parent_id gibt die Stelle im Baum an). Mit updated_since sind sie aufsteigend nach updated_at und dann nach id sortiert, ohne diesen Parameter in der Reihenfolge von sort_key. Sammlungen ohne passende Ordner werden ausgelassen.

Authentifizierung

Senden Sie einen API-Schlüssel im Header Authorization: Authorization: Bearer <Schlüssel>.

Query-Parameter

  • limitinteger

    Seitengröße. Ohne limit und cursor wird die gesamte Liste zurückgegeben; ist der Parameter angegeben, höchstens limit Einträge, und die nächste Seite steht in den Headern Link (rel="next") und X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Cursor der nächsten Seite aus X-Next-Cursor oder next_cursor der vorherigen Antwort mit denselben Filtern; er enthält die Seitengröße. Zusammen mit offset: 422 validation.failed; ein Cursor einer anderen Liste, mit anderen Filtern oder ein fehlerhafter Cursor: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Nur Objekte mit updated_at ab diesem Zeitpunkt (einschließlich; RFC 3339 mit Offset), zur Synchronisierung. Damit wird die Liste aufsteigend nach updated_at und dann nach id sortiert, und der Cursor setzt diese Reihenfolge fort. Gelöschte Objekte werden nicht aufgeführt: Löschungen werden als Ereignisse gemeldet.

    length ≤ 512

  • metadatamap of string

    Filter nach metadata: metadata[<key>]=<value> prüft auf exakte Übereinstimmung. Bis zu 3 Bedingungen, die alle erfüllt sein müssen (?metadata[team]=support&metadata[crm_id]=A-1042). Mehr als 3 Bedingungen oder ein ungültiger Schlüssel ergeben 400 api.metadata_invalid.

Antworten

200Erfolgreiche Antwort

Antwort-Header

  • Link

    Adresse der nächsten Seite, <…>; rel="next". Fehlt der Header, ist dies die letzte Seite.

  • X-Next-Cursor

    Cursor der nächsten Seite für den Parameter cursor. Fehlt der Header, ist dies die letzte Seite.

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: FolderTreeList

array of FolderTree
  • collection_idintegererforderlich
  • collection_namestringerforderlich
  • collection_titlestringerforderlich

    Name der Sammlung für die Anzeige.

  • permissionsarray of stringerforderlich

    Die effektiven Berechtigungen des Benutzers für die Sammlung.

  • unfiledintegererforderlich

    Für den Benutzer verfügbare Karten der Sammlung, die in keinem Ordner liegen. Archivierte Karten werden nicht gezählt, wie in der standardmäßigen Kartenliste.

  • foldersarray of FolderNodeerforderlich
401Es wurden keine Anmeldedaten gesendet (weder ein Sitzungscookie noch ein API-Schlüssel), oder der Schlüssel wurde nicht gefunden.

Antwort-Header

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

429Zu viele Anfragen (`api.rate_limited`), das Kontingent der Organisation für die Minute, den Tag oder den Monat ist aufgebraucht (`api.quota_exceeded`; `error.details` enthält `quota`, `limit` und `reset_at`), das Limit der Organisation ist erreicht, oder der Antwortdienst ist ausgelastet (`answers.engine_busy`). Warten Sie die im Header `Retry-After` angegebene Zeit ab.

Antwort-Header

  • Retry-After

    Anzahl der Sekunden, die Sie warten sollten, bevor Sie die Anfrage wiederholen.

  • RateLimit-Policy

    Geltende Limits im Format des IETF-Entwurfs draft-ietf-httpapi-ratelimit-headers: durch Kommas getrennte Einträge "<name>";q=<quota>;w=<window in seconds>. key ist die Anfragerate des API-Schlüssels (das Kontingent ist der Burst, das Fenster die Zeit bis zum vollständigen Auffüllen; für eine Sitzung heißt der Eintrag user, ohne Anmeldedaten ip); minute, day und month sind die Kontingente der Organisation für die Kalenderminute, den Kalendertag und den Kalendermonat in UTC.

  • RateLimit

    Was von jedem Limit in RateLimit-Policy übrig ist: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit des strengsten Eintrags in RateLimit-Policy (des Eintrags mit den wenigsten verbleibenden Anfragen).

  • X-RateLimit-Remaining

    Verbleibende Anfragen unter dem strengsten Limit.

  • X-RateLimit-Reset

    Sekunden bis zum Zurücksetzen des strengsten Limits.

application/json

Objekt: Error

Fehlercodes

Codes, die dieser Endpunkt in error.code zurückgeben kann, zusätzlich zu den allgemeinen Codes jeder Anfrage.

Ratenlimits

Antworten enthalten die Header RateLimit und RateLimit-Policy sowie die älteren X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Eine Antwort 429 enthält Retry-After in Sekunden: Warten Sie und versuchen Sie es dann erneut.

← folders · API-Referenz