Obter uma lista pelo endereço

GET/v1/collections/by-path/{username}/{slug}

Retorna uma lista pelo nome de usuário do dono e pelo slug, as duas partes do endereço da lista.

Requisição

Shell

curl -g "https://api.nogitsu.com/v1/collections/by-path/{username}/{slug}"

Parâmetros

username
caminhoobrigatório
O nome de usuário do membro.
texto
slug
caminhoobrigatório
O slug do endereço da página em nogitsu.com.
texto

Resposta

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

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)
themeobjetopode ser null
- backgroundtexto
- accenttexto
- fonttexto
  Valores permitidosdefaultserifmono
- densitytexto
  Valores permitidoscomfortablecompact
- layouttexto
  Valores permitidosrowsposters
- showsCurrentlyConsumingtrue ou false
copiedFromobjetopode ser null
- nametexto
- pathtexto
- ownerDisplayNametexto

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