Sign in
recitations

List all Recitations (audio recordings)

Changed on
get/recitations/

Request

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

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.

rasm_ol_mushaf'hafs' required

Short name of the Mushaf to filter Recitations by. Common value: 'hafs'. Any string is accepted. (e.g. 'hafs', 'warsh', etc.)

reciter_idstring uuid

id of the Reciter to filter Recitations by.

searchstring

A search term.

Response

idstring uuid required
status'draft' | 'pending_review' | 'published'
  • draft - Draft
  • pending_review - Pending review
  • published - Published
recitation_datestring date nullable
recitation_locationstring nullable
recitation_typestring required
track_countstring required
created_atstring date-time required
updated_atstring date-time required
mushaf_idstring uuid required

Changes

  • d36549551285Revision changes
    • breaking

      added the new required query request parameter rasm_ol_mushaf

    • warning

      deleted the query request parameter mushaf

  • edd2c4f2de3bRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

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

    • breaking

      removed the required property / from the response with the status

    • warning

      deleted the query request parameter reciter_uuid

    • info

      added the new optional query request parameter reciter_id

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

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

    • info

      added the required property / to the response with the status