Retrieve the status of messages in a queue

Request

Lists messages for a specific queue and status, including links for paging and message details.

Security

OAuth2

Path

queueNamestringrequired

The name of the queue, for example, default.

statusstringrequired

The status of messages to retrieve, for example, in, wip, complete, and deadletter.

Query

skipinteger, (int32)

The number of records to skip before retrieving results, for example, 0.

takeinteger, (int32)

The number of records to retrieve, for example: 25. The maximum number that can be retrieved is 100.

curl -i -X GET \
  'https://your-server/api/status/queues/{queueName}/{status}?skip=0&take=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Body

messagesArray of objects or null(Link)

List of message links in the queue.

total_messagesinteger or null, (int64)

Total number of messages in the queue.

returned_messagesinteger or null, (int64)

Number of messages returned in the current response.

offsetinteger or null, (int32)

Offset of the returned messages.

nextobject(Link)

Link to the next page of results.

previousobject(Link)

Link to the previous page of results.

selfobject(Link)

Link to this resource.

Response

{
  "messages": [
    { … }
  ],
  "total_messages": 0,
  "returned_messages": 0,
  "offset": 0,
  "next": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "previous": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}