Retrieve list of queue fields
GET {{baseUrl}}/queues?offset=5&limit=25
Issuers and acquirers use this endpoint to retrieve a list of queues and their fields.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | number | Specifies the number of items to offset the start of the list. | |
limit | number | Number of items the list should be limited to. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":10,"offset":5,"limit":25,"total":5000,"definitions":{"type":"array","description":"List of queue definitions.","maxItems":2,"items":{"type":"object","description":"List of queue definitions.","properties":{"queueId":{"type":"string","description":"Identifier assigned by Mastercom to the queue.","example":"10"},"queueName":{"type":"string","description":"Name of the queue.","example":"Pending Documentation"},"description":{"type":"string","description":"Description of queue.","example":"Pending Documentation"},"queueType":{"type":"string","description":"Type of queue.","example":"STANDARD"},"sortKey":{"type":"string","description":"Field by which the items are sorted.","example":"eventExpiryDateTime"},"sortOrder":{"type":"string","description":"Order by which the items are sorted.","example":"ASC"},"fields":{"type":"array","description":"The list of fields that can be fetched from this queue.","maxItems":2,"items":{"type":"object","description":"A field that can be fetched from this queue.","properties":{"fieldName":{"type":"string","description":"Field name in queue.","example":"claimId"},"fieldDataType":{"type":"string","description":"Data type of the associated field name.","example":"STRING"}}}}}}}}