GAganjoor
Ganjoor

get poem by id

Changed on
get/api/ganjoor/poem/{id}

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

idinteger required

Query parameters

catInfoboolean
catPoemsboolean
rhymesboolean
recitationsboolean
imagesboolean
songsboolean
commentsboolean

not implemented yet

verseDetailsboolean
navigationboolean

next/previous

relatedpoemsboolean
commentSortOrder0 | 1 | 2

how to sort a poem's comments

Response

OK

idinteger

Id

titlestring nullable

title

fullTitlestring nullable

cat + parent cats title + title

urlSlugstring nullable

url => slug

fullUrlstring nullable

sample: /hafez/ghazal/sh1

plainTextstring nullable

verses text

htmlTextstring nullable

verses text as html (ganjoor.net format)

sourceNamestring nullable

source name

sourceUrlSlugstring nullable

source url slug

oldTagstring nullable

old collection or book name for Saadi's ghazalyiat (طیبات، خواتیم و ....)

oldTagPageUrlstring nullable

old collection page url e.g /saadi/tayyebat

mixedModeOrderinteger

order when mixed with categories

publishedboolean

published

languagestring nullable

language

poemSummarystring nullable

poem summary

sectionIndexinteger nullable

section index

claimedByMultiplePoetsboolean

poem is claimed by multiple poets

coupletsCountinteger nullable

couplets count

Changes