Pular para o conteúdo

Listar listas públicas

GET/v1/collections

Retorna listas públicas criadas por membros, ou apenas as listas que contêm uma obra.

Requisição

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

Parâmetros

  • cursor

    consultaopcional

    O valor de nextCursor da página anterior. Omita-o na primeira página.

    texto

  • workId

    consultaopcional

    Apenas listas que contêm esta obra.

    texto (uuid)

  • language

    consultaopcional

    Apenas listas escritas neste idioma.

    texto

Resposta

Uma requisição bem-sucedida responde 200 com este JSON:

  • itemslista de objeto
    • idtexto (uuid)
    • nametexto
    • slugtexto
    • pathtexto
    • descriptiontextopode ser null
    • visibilitytexto
      Valores permitidospublicunlistedprivate
    • isOrderedtrue ou false
    • languagetexto
      Valores permitidosentrdefresptitruidjakozh
    • itemCountnúmero inteiro

      De 0 a 9007199254740991

    • subscriberCountnúmero inteiro

      De 0 a 9007199254740991

    • ownerobjeto
      • usernametexto
      • displayNametexto
      • avatarUrltexto (uri)pode ser null
    • coverslista de objeto
      • urltexto (uri)
      • variantWidthslista de número inteiro

        De -9007199254740991 a 9007199254740991

    • isRemovedtrue ou false
    • isIndexabletrue ou false
    • createdAttexto (date-time)
    • updatedAttexto (date-time)
  • nextCursortextopode ser null

Erros

Como toda operação, esta pode responder 400 para parâmetros inválidos, 404 quando nada é encontrado e 429 quando você envia requisições demais. Todos os erros compartilham o mesmo formato.

Leia sobre erros