general
mushafs

List all Mushafs (Quranic manuscripts/editions)

Changed on
get/mushafs/

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.

searchstring

A search term.

Response

idstring uuid required
slugstring required
namestring required
status'draft' | 'pending_review' | 'published'
  • draft - Draft
  • pending_review - Pending review
  • published - Published
compilerstring uuid nullable
is_primaryboolean

Changes

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became optional for the status

    • breaking

      removed the required property / from the response with the status

    • info

      added the optional property / to the response with the status

    • warning

      removed the optional property / from 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