Get a post

GET/v1/posts/{id}

Returns a post with its text, poll, images and community.

Request

Shell

curl -g "https://api.nogitsu.com/v1/posts/{id}"

Parameters

id
pathrequired
Id of the item, a UUID.
text
reveal
queryoptional
Set to 1 to include the text of a post marked as a spoiler.
text
Allowed values1

Answer

A successful request answers 200 with this JSON:

idtext (uuid)
slugtext
communityobject
- idtext (uuid)
- slugtext
- languagetext
- kindtext
  Allowed valuesworkboarduser
- nametext
- iconUrltext (uri)can be null
- themetext
  Allowed valuesvioletblueskycyanemeraldgreenyellowamberrosepink
- isSampletrue or false
authorobjectcan be null
- usernametext
- displayNametext
- avatarUrltext (uri)can be null
authorFlairtextcan be null
kindtext
Allowed valuestextlinkimagepoll
titletextcan be null
excerpttextcan be null
flairobjectcan be null
- idtext (uuid)
- labeltext
- tonetext
  Allowed valuesneutralaccentsuccesswarningdangervioletblueskycyanemeraldgreenyellowamberrosepink
spoilerobjectcan be null
- workTitletextcan be null
- unitNumbernumbercan be null
  At least 0
workobjectcan be null
- idtext (uuid)
- titletext
- mediumtext
  Allowed valuesanimedonghuaanimationmangamanhwamanhuawebtoon
- slugtext
- unitNumbernumbercan be null
  At least 0
isAdulttrue or false
isPinnedtrue or false
isLockedtrue or false
scorewhole numbercan be null
From -9007199254740991 to 9007199254740991
commentCountwhole number
From 0 to 9007199254740991
reactionslist of object
- kindtext
  Allowed valueslovelaughwowsadclapfirethinkangrypartycry
- countwhole number
  From 0 to 9007199254740991
linkobjectcan be null
- urltext (uri)
- hosttext
- titletextcan be null
- descriptiontextcan be null
- imageobjectcan be null
  urltext (uri)
  widthwhole number
  From 0 to 9007199254740991
  heightwhole number
  From 0 to 9007199254740991
  alttextcan be null
  variantWidthslist of whole number
  From 0 to 9007199254740991
- isPendingtrue or false
imageslist of object
- urltext (uri)
- widthwhole number
  From 0 to 9007199254740991
- heightwhole number
  From 0 to 9007199254740991
- alttextcan be null
- variantWidthslist of whole number
  From 0 to 9007199254740991
pollobjectcan be null
- optionslist of object
  idtext (uuid)
  labeltext
  voteCountwhole numbercan be null
  From 0 to 9007199254740991
- totalVoteswhole number
  From 0 to 9007199254740991
- closesAttext (date-time)
- isClosedtrue or false
- allowsMultipletrue or false
createdAttext (date-time)
editedAttext (date-time)can be null
bodyobjectcan be null
- blockslist of one of several shapes
  Option 1
  typetext
  Allowed valuesparagraph
  childrenlist of one of several shapes
  Option 1
  typetext
  Allowed valuestext
  texttext
  markslist of any value
  Option 2
  typetext
  Allowed valueslink
  hreftext (uri)
  childrenlist of any value
  Option 3
  typetext
  Allowed valuesmention
  usernametext
  Option 4
  typetext
  Allowed valuesspoiler
  spoilerIdtext
  childrenlist of any valuecan be null
  Option 5
  typetext
  Allowed valuesbreak
  Option 2
  typetext
  Allowed valuesheading
  childrenlist of one of several shapes
  Option 1
  typetext
  Allowed valuestext
  texttext
  markslist of any value
  Option 2
  typetext
  Allowed valueslink
  hreftext (uri)
  childrenlist of any value
  Option 3
  typetext
  Allowed valuesmention
  usernametext
  Option 4
  typetext
  Allowed valuesspoiler
  spoilerIdtext
  childrenlist of any valuecan be null
  Option 5
  typetext
  Allowed valuesbreak
  Option 3
  typetext
  Allowed valuesquote
  childrenlist of RichTextBlock
  Option 4
  typetext
  Allowed valueslist
  isOrderedtrue or false
  itemslist of list of RichTextBlock
  Option 5
  typetext
  Allowed valuescode
  texttext
isDeletedtrue or false

Errors

Like every operation, this one can answer 400 for invalid parameters, 404 when nothing is found and 429 when you send too many requests. All errors share one shape.

Read about errors