translations

List all AyahTranslations for this Translation

Returns a paginated list of all AyahTranslation objects for the given Translation id. Optionally filter by surah_id (query param).

get/translations/{id}/ayahs/

Request

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

Path parameters

idstring uuid required

A UUID string identifying this translation.

Query parameters

limitinteger

Number of results to return per page.

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

id of the Surah to filter AyahTranslations by.

Response

idstring uuid required
translation_idstring uuid required
ayah_idstring uuid required
textstring required
bismillahstring nullable

Changes

No recorded changes to this operation across all 22 revisions of this API.