User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

Get all collections

List collections owned by the user. This api contains pagination. Read more about pagination

Query Parameters

sortBy string

Possible values: [recentlyUpdated, alphabetical]

Sort the collections list either by the time they were updated at descendingly or alphabetically.

type string

Possible values: [page, juz, surah, ayah]

Filter collections to ones with bookmarks of this type.

last integer

Possible values: >= 1 and <= 20

The number of items to be fetched. Should be used together with before

first object

Possible values: >= 1 and <= 20

The number of items to be fetched.

after object

The cursor after which you want to get the next page of items. Should be used together with first

before object

The cursor before which the previous page of items will be fetched. Should be used together with last

Responses

• 200
• 400
• 401
• 403
• 404
• 422
• 429
• 500
• 502
• 503
• 504

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean
data object[]
Array [
id string required
name string required
slug string nullable required
isPrivate boolean required
isDefault boolean required
modifiable boolean required
updatedAt date-time nullable required
url string nullable
bookmarksCount integer
resourcesCount integer
count integer
]
pagination object
startCursor string
endCursor string
hasNextPage boolean
hasPreviousPage boolean

{
  "success": true,
  "data": [
    {
      "id": "cmpzhtfua0008jj281doe8qto",
      "name": "Woman in Quran",
      "slug": "woman-in-quran",
      "isPrivate": false,
      "isDefault": false,
      "modifiable": true,
      "updatedAt": "2023-01-21T07:28:13.023Z",
      "url": "cmnkcpmvc000814v9f5jtbsxf",
      "bookmarksCount": 1,
      "resourcesCount": 1,
      "count": 1
    }
  ],
  "pagination": {
    "startCursor": "cmpzhtf9c0002jj28e2182nft",
    "endCursor": "cmpzhtf9c0003jj28fadj390l",
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

{
  "success": true,
  "data": [
    {
      "id": "cmpzhtfua0008jj281doe8qto",
      "name": "Woman in Quran",
      "slug": "woman-in-quran",
      "isPrivate": false,
      "isDefault": false,
      "modifiable": true,
      "updatedAt": "2023-01-21T07:28:13.023Z",
      "url": "cmnkcpmvc000814v9f5jtbsxf",
      "bookmarksCount": 1,
      "resourcesCount": 1,
      "count": 1
    }
  ],
  "pagination": {
    "startCursor": "cmpzhtf9c0002jj28e2182nft",
    "endCursor": "cmpzhtf9c0003jj28fadj390l",
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

Loading...