Queues
Queue Listing
Queues are completely hidden from non-support users. You can add/remove discussions using the queue/unqueue actions on the discussion resource.
> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/queues"
{
"offset": 0,
"total": 3,
"per_page": 30,
"named_queues": [
{QUEUE}, {QUEUE}, etc
]
}
Single Queue
> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/queues/12345"
{
"name": "UI issues",
"permalink": "ui-issues",
"show_order": "last_updated",
"show_states": [
"new",
"open",
"assigned"
],
"notification_ids": [
"15077"
],
"created_at": "2009-02-10T07:00:25Z",
"updated_at": "2009-03-13T23:28:33Z",
"html_href": "https://help.tenderapp.com/dashboard/queues/12345",
"href": "https://api.tenderapp.com/help/queues/12345",
"discussions_href": "https://api.tenderapp.com/help/queues/12345/discussions{-opt|?|page,user_email}{-join|&|page,user_email}"
}
User queues
Each support user has his own queue, and when you assign a discussion to a user, you are actually putting that discussion into the user queue. This means that you can use queues to get all the discussions assigned to a user for example.
To get your queue, use mine
as the ID:
> curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/queues/mine"
Attributes
- name - the name of the queue.
- permalink - the name used in queue URLs. This is auto-generated from the name if not already provided.
- show_order - The default order of discussions
in queues. The valid values are
queue
,last_updated
, andage
. - show_states - The discussion states to show in
the queue discussions query. See the discussions resource for more about
discussion states. This value must stay an array. The valid values
are
new
,open
,assigned
, andresolved
. - user_id - If this queue is the assignment queue of a support staff, this will be the support staff ID. If it's a normal queue, it's empty.
- notification_ids - Array of user IDs that are notified when discussions are added to the queue.
- href - API URL for the queue.
- html_href - Web URL for the queue.
- discussions_href (readonly) - URI template for selecting all discussions in this queue. See the discussion resource for info on parsing the URI templates for discussions.
- new_discussions_count - number of unresponded discussions
- open_discussions_count - number of open discussions
- resolved_discussions_count - number of closed discussions
- assigned_discussions_count - number of ticketed discussions
All discussions
You can get all the discussions in a queue:
curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/queues/12345/discussions"
This work for your queue as well:
curl -H "Accept: application/vnd.tender-v1+json" "https://USER:PASS@api.tenderapp.com/help/queues/mine/discussions"