Sign in
ayahs

List all Ayahs (Quran verses)

Changed on
get/ayahs/

Request

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

Query parameters

include_surahboolean
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.

surah_idstring uuid

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)

Changes

  • 6a32b48befe9Revision changes
    • info

      added the new optional query request parameter include_surah

  • 461db82462c7Revision changes
    • breaking

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