Get collection items by id

Get all resources that belong to an existing collection by collection id.

Path Parameters

collectionId string

Query Parameters

sortBy string

Possible values: [recentlyAdded, verseKey]

Sort the collection items either by the time they were added at descendingly or by Ayah key.

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
• 403
• 404
• 422
• 500

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object
collection object
id string required
updatedAt date-time required
name string required
bookmarks object[]
Array [
id string required
createdAt date-time required
type string required
key integer required
verseNumber integer
group string
]
pagination object
startCursor string
endCursor string
hasNextPage boolean
hasPreviousPage boolean

{
  "success": true,
  "data": {
    "collection": {
      "id": "clz2z4jc600070nq9abp1huip",
      "updatedAt": "2023-01-21T07:28:13.023Z",
      "name": "Woman in Quran"
    },
    "bookmarks": [
      {
        "id": "clz2z4j8n00050nq91ppa74pr",
        "createdAt": "2023-01-21T07:28:13.023Z",
        "type": "ayah",
        "key": 1,
        "verseNumber": 5,
        "group": "string"
      }
    ]
  },
  "pagination": {
    "startCursor": "clz2z4ivs00020nq9fvoz2qff",
    "endCursor": "clz2z4ivt00030nq93r4ceta1",
    "hasNextPage": true,
    "hasPreviousPage": 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)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

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

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

Loading...