Öffentliche Listen auflisten

GET/v1/collections

Liefert öffentliche Listen von Mitgliedern oder nur die Listen, die ein bestimmtes Werk enthalten.

Anfrage

Shell

curl "https://api.nogitsu.com/v1/collections"

Parameter

cursor
Queryoptional
Der nextCursor-Wert der vorherigen Seite. Lass ihn für die erste Seite weg.
Text
workId
Queryoptional
Nur Listen, die dieses Werk enthalten.
Text (uuid)
language
Queryoptional
Nur Listen, die in dieser Sprache geschrieben sind.
Text

Antwort

Eine erfolgreiche Anfrage antwortet mit 200 und diesem JSON:

itemsListe von Objekt
- idText (uuid)
- nameText
- slugText
- pathText
- descriptionTextkann null sein
- visibilityText
  Erlaubte Wertepublicunlistedprivate
- isOrderedtrue oder false
- languageText
  Erlaubte Werteentrdefresptitruidjakozh
- itemCountGanzzahl
  Von 0 bis 9007199254740991
- subscriberCountGanzzahl
  Von 0 bis 9007199254740991
- ownerObjekt
  usernameText
  displayNameText
  avatarUrlText (uri)kann null sein
- coversListe von Objekt
  urlText (uri)
  variantWidthsListe von Ganzzahl
  Von -9007199254740991 bis 9007199254740991
- isRemovedtrue oder false
- isIndexabletrue oder false
- createdAtText (date-time)
- updatedAtText (date-time)
nextCursorTextkann null sein

Fehler

Wie jede Operation kann auch diese mit 400 bei ungültigen Parametern antworten, mit 404, wenn nichts gefunden wird, und mit 429, wenn du zu viele Anfragen sendest. Alle Fehler haben dieselbe Form.

Mehr über Fehler