Get all collections
List collections owned by the user. This api contains pagination. Read more about pagination
Query Parameters
Possible values: [recentlyUpdated
, alphabetical
]
Sort the collections list either by the time they were updated at descendingly or alphabetically.
Possible values: >= 1
and <= 20
The number of items to be fetched. Should be used together with before
Possible values: >= 1
and <= 20
The number of items to be fetched.
The cursor after which you want to get the next page of items. Should be used together with first
The cursor before which the previous page of items will be fetched. Should be used together with last
- 200
- 403
- 404
- 422
- 500
Request has been handled successfully.
Schema
- Array [
- ]
data object[]
pagination object
{
"success": true,
"data": [
{
"id": "cm1ll561g00071dq789y988zu",
"updatedAt": "2023-01-21T07:28:13.023Z",
"name": "Woman in Quran"
}
],
"pagination": {
"startCursor": "cm1ll55l800021dq7epqpcylm",
"endCursor": "cm1ll55l800031dq791nvarqa",
"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.
Schema
error object
{
"success": false,
"error": {
"code": "ForbiddenError",
"message": "Token expired"
}
}
Not Found. The resource being accessed does not exist.
Schema
error object
{
"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.
Schema
error object
{
"success": false,
"error": {
"code": "ValidationError",
"message": "`id` is required"
}
}
Server Error. Something went wrong, try again later.
Schema
error object
{
"success": false,
"error": {
"code": "ServerError",
"message": "Something went wrong"
}
}