Workspaces

Admins in Zendesk Support can set up contextual workspaces to present ticket tools and features based on specific workflows. For more information, see Setting up contextual workspaces (Enterprise).

List Workspaces

GET /api/v2/workspaces.json

Allowed For
  • Admin
Using curl
curl https://{subdomain}.zendesk.com/api/v2/workspaces.json
curl https://{subdomain}.zendesk.com/api/v2/workspaces.json?per_page=2
Example Response
Status: 200 OK

  {
     "workspaces": [
  {
    "url": "https://{subdomain}.zendesk.com/api/v2/workspaces.json",
    "id": 3133,
    "title": "Test Workspace 1",
    "description": "Test rules",
    "macros": [
      360005374974,
      ...,
    ],
    "macro_ids": [
      360005374974,
      ...,
    ],
    "apps": [
      {
        "id": 360000080413,
        "expand": false,
        "position": 1
      },
      ...
    ],
    "ticket_form_id": 360000014173,
    "position": 1,
    "activated": true,
    "prefer_workspace_app_order": true,
    "selected_macros": [
      {
        "url": "https://{subdomain}.zendesk.com/api/v2/macros/360005374974.json",
        "id": 360005374974,
        "title": "Close and redirect to topics",
        "active": true,
        "updated_at": "2018-11-08T22:27:00Z",
        "created_at": "2018-02-08T23:45:30Z",
        "position": 9999,
        "description": null,
        "actions": [
          {
            "field": "status",
            "value": "solved"
          },
          ...
        ],
        "restriction": {
          "type": "Group",
          "id": 360002226093,
          "ids": [
            360002226093
         ]
        },
        "usage_7d": 0
      },
      ...
    ],
    "updated_at": "2018-12-17T22:37:40Z",
    "created_at": "2018-11-13T19:08:13Z",
    "conditions": {
      "all": [
        {
          "field": "ticket_form_id",
          "operator": "is",
          "value": "360000014173"
        },
      ],
      "any": []
    }
  },
....
],
  "next_page": null,
  "previous_page": null,
  "count": 1
}