Sign in
recitations

Retrieve a specific Recitation by id

Changed on
get/recitations/{id}/

Request

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

Path parameters

idstring uuid required

A UUID string identifying this recitation.

Query parameters

surah_idstring uuid

id of the Surah to filter timestamps by. When provided, only timestamps for this surah are returned.

Response

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

Changes