Get list of request queues
Lists all of a user's request queues. The response is a JSON array of objects, where each object contains basic information about one queue.
By default, the objects are sorted by the createdAt field in ascending order, therefore you can use pagination to incrementally fetch all queues while new ones are still being created. To sort them in descending order, use desc=1 parameter. The endpoint supports pagination using limit and offset parameters and it will not return more than 1000 array elements.
Query parameters
Number of items that should be skipped at the start. The default value is 0.
Maximum number of items to return. The default value as well as the maximum is 1000.
If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.
If true or 1 then all the storages are returned. By default, only named storages are returned.
Filter by ownership. If this parameter is omitted, all accessible request queues are returned.
- ownedByMe: Return only request queues owned by the user.
- sharedWithMe: Return only request queues shared with the user by other users.
Response
Example response
{
"data": {
"total": 1,
"limit": 1000,
"count": 1,
"items": [
{
"id": "WkzbQMuFYuamGv3YF",
"name": "some-name",
"userId": "wRsJZtadYvn4mBZmm",
"username": "janedoe",
"createdAt": "2019-12-12T07:34:14.202Z",
"modifiedAt": "2019-12-13T08:36:13.202Z",
"accessedAt": "2019-12-14T08:36:13.202Z",
"expireAt": "2019-06-02T17:15:06.751Z",
"totalRequestCount": 870,
"handledRequestCount": 100,
"pendingRequestCount": 670,
"hadMultipleClients": true,
"generalAccess": "RESTRICTED",
"stats": {
"headItemReadCount": 5,
"readCount": 100,
"storageBytes": 1024,
"writeCount": 10
}
}
]
}
}