GET
/v1/admin/support-teamsEvery support team of the firm, by name, with its members and how many open tickets it holds. A ticket can be given to a team as well as to an agent. Everybody on the team counts it as "mine". When it waits for the team and no agent holds it, everybody on the team gets the bell.
Teams belong to the support settings, so reading them takes view_tickets or
manage_support_settings, and changing them manage_support_settings, as on
the web. The ticket's can.teams says whether this person may change them. A
firm has a handful, so the list comes whole, without pages.
Needs a firm. Our own staff name one with the Propper-Workspace header.
Request
curl "https://api.proppertrading.com/v1/admin/support-teams" \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
-H "Propper-Workspace: acme"
Response
{
"data": [
{
"object": "support_team",
"id": "team_cmhg8847tuqg3mq6",
"name": "Payouts desk",
"members": [
{
"id": "usr_pj68ba8tmrbb7fxb",
"name": "Ios Tester"
}
],
"open": 1,
"mine": true
}
],
"meta": {
"request_id": "req_01m50v19g5nwh9r4x936543777",
"has_more": false,
"next_cursor": null
}
}
| Field | Description |
|---|---|
name | Unique within the firm, up to 100 characters |
members | The agents on it, by name, each with id and name |
open | The tickets given to it that have not ended |
mine | You are on it |
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | workspace_required | Asked by our own staff without naming a firm |
| 401 | invalid_token | Not a token, or the secret does not match |
| 401 | revoked_token | Signed out here or from another device |
| 401 | expired_token | Ninety days without use, or a set expiry passed |
| 403 | admin_access_required | This account no longer helps run the environment |
| 403 | insufficient_scope | This device does not hold admin:read |
| 403 | workspace_not_permitted | The Propper-Workspace header names an environment this account cannot act in |
| 403 | forbidden | Without view_tickets or manage_support_settings |