Sign in
ayahs

Get random Ayah(s)

Changed on
get/ayahs/random/

Request

  • The document declares no server URL.
  • Auth: API key in header Authorization

Query parameters

countinteger

Number of random ayahs to return. Defaults to 1.

limitinteger

Number of results to return per page.

numberinteger
offsetinteger

The initial index from which to return the results.

ordering'asc' | 'desc'

Which field to use when ordering the results.

searchstring

A search term.

Response

idstring uuid required
numberinteger required
sajdah'none' | 'null' nullable
  • none - None
textstring required
breakersstring required
is_bismillahboolean
surah_numberstring required
lengthinteger

Character count of the ayah text (joined words)

rasm_ol_mushafstring required

Changes

  • 7ea4a6ef2fb1Revision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      removed the required write-only property items/words/items/ayah_id from the response with the status

  • aa7b100ef965Revision changes
    • breaking

      removed the required property /// from the response with the status