Zendesk

Zendesk Workspaces API

The Workspaces API from Zendesk — 4 operation(s) for workspaces.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/targets/targets/
📖
Documentation
https://developer.zendesk.com/api-reference/sales-crm/resources/account/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/
📖
Documentation
https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/
📖
Documentation
https://developer.zendesk.com/api-reference/custom-data/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/users/users/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/groups/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/
📖
Documentation
https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/lookup_relationships/lookup_relationships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/views/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/zendesk-workspaces-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-ticket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-user-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-ld/zendesk-context.jsonld

OpenAPI Specification

zendesk-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  version: '1.0'
  title: Zendesk Account Account Settings Workspaces API
  description: Needs a description.
tags:
- name: Workspaces
paths:
  /api/v2/workspaces:
    get:
      operationId: ListWorkspaces
      tags:
      - Workspaces
      summary: Zendesk Get  Api V2 Workspaces
      description: '#### Allowed For


        * Admins, Agents

        '
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
              examples:
                default:
                  value:
                    count: 1
                    next_page: null
                    previous_page: null
                    workspaces:
                    - activated: true
                      apps:
                      - expand: false
                        id: 360000080413
                        position: 1
                      conditions:
                        all:
                        - field: ticket_form_id
                          operator: is
                          value: '360000014173'
                        any: []
                      created_at: '2018-11-13T19:08:13Z'
                      description: Test rules
                      id: 3133
                      macro_ids:
                      - 360005374974
                      position: 1
                      prefer_workspace_app_order: true
                      selected_macros:
                      - actions:
                        - field: status
                          value: solved
                        active: true
                        created_at: '2018-02-08T23:45:30Z'
                        description: null
                        id: 360005374974
                        position: 9999
                        restriction:
                          id: 360002226093
                          ids:
                          - 360002226093
                          type: Group
                        title: Close and redirect to topics
                        updated_at: '2018-11-08T22:27:00Z'
                        url: https://{subdomain}.zendesk.com/api/v2/macros/360005374974.json
                        usage_7d: 0
                      ticket_form_id: 360000014173
                      title: Test Workspace 1
                      updated_at: '2018-12-17T22:37:40Z'
                      url: https://{subdomain}.zendesk.com/api/v2/workspaces.json
    post:
      operationId: CreateWorkspace
      tags:
      - Workspaces
      summary: Zendesk Post  Api V2 Workspaces
      description: '#### Allowed For


        * Admins

        '
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                workspace:
                  $ref: '#/components/schemas/WorkspaceInput'
            examples:
              default:
                value:
                  workspace:
                    conditions:
                      all:
                      - field: ticket_form_id
                        operator: is
                        value: '360000014173'
                      any: []
                    description: Test rules
                    macros:
                    - 360005374974
                    ticket_form_id: 360000014173
                    title: Test Workspace 1
      responses:
        '201':
          description: Created workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    $ref: '#/components/schemas/WorkspaceObject'
              examples:
                default:
                  value:
                    workspace:
                      activated: true
                      apps: []
                      conditions:
                        all:
                        - field: ticket_form_id
                          operator: is
                          value: '360000014173'
                        any: []
                      created_at: '2018-11-13T19:08:13Z'
                      description: Test rules
                      id: 3133
                      macro_ids:
                      - 360005374974
                      position: 1
                      prefer_workspace_app_order: true
                      selected_macros:
                      - actions:
                        - field: status
                          value: solved
                        active: true
                        created_at: '2018-02-08T23:45:30Z'
                        description: null
                        id: 360005374974
                        position: 9999
                        restriction:
                          id: 360002226093
                          ids:
                          - 360002226093
                          type: Group
                        title: Close and redirect to topics
                        updated_at: '2018-11-08T22:27:00Z'
                        url: https://{subdomain}.zendesk.com/api/v2/macros/360005374974.json
                        usage_7d: 0
                      ticket_form_id: 360000014173
                      title: Test Workspace 1
                      updated_at: '2018-12-17T22:37:40Z'
                      url: https://{subdomain}.zendesk.com/api/v2/workspaces.json
  /api/v2/workspaces/{workspace_id}:
    parameters:
    - $ref: '#/components/parameters/WorkspaceId'
    get:
      operationId: ShowWorkspace
      tags:
      - Workspaces
      summary: Zendesk Get  Api V2 Workspaces Workspace_id
      description: '#### Allowed For

        * Admins

        '
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    $ref: '#/components/schemas/WorkspaceObject'
              examples:
                default:
                  value:
                    workspace:
                      activated: true
                      apps: []
                      conditions:
                        all:
                        - field: ticket_form_id
                          operator: is
                          value: '360000014173'
                        any: []
                      created_at: '2018-11-13T19:08:13Z'
                      description: Test rules
                      id: 3133
                      macro_ids:
                      - 360005374974
                      position: 1
                      prefer_workspace_app_order: true
                      selected_macros:
                      - actions:
                        - field: status
                          value: solved
                        active: true
                        created_at: '2018-02-08T23:45:30Z'
                        description: null
                        id: 360005374974
                        position: 9999
                        restriction:
                          id: 360002226093
                          ids:
                          - 360002226093
                          type: Group
                        title: Close and redirect to topics
                        updated_at: '2018-11-08T22:27:00Z'
                        url: https://{subdomain}.zendesk.com/api/v2/macros/360005374974.json
                        usage_7d: 0
                      ticket_form_id: 360000014173
                      title: Test Workspace 1
                      updated_at: '2018-12-17T22:37:40Z'
                      url: https://{subdomain}.zendesk.com/api/v2/workspaces.json
    put:
      operationId: UpdateWorkspace
      tags:
      - Workspaces
      summary: Zendesk Put  Api V2 Workspaces Workspace_id
      description: '#### Allowed For

        * Admins'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                workspace:
                  $ref: '#/components/schemas/WorkspaceInput'
            examples:
              default:
                value:
                  workspace:
                    conditions:
                      all:
                      - field: ticket_form_id
                        operator: is
                        value: '360000014173'
                      any: []
                    description: Test rules
                    macros:
                    - 360005374974
                    ticket_form_id: 360000014173
                    title: Test Workspace 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    $ref: '#/components/schemas/WorkspaceObject'
              examples:
                default:
                  value:
                    workspace:
                      activated: true
                      apps: []
                      conditions:
                        all:
                        - field: ticket_form_id
                          operator: is
                          value: '360000014173'
                        any: []
                      created_at: '2018-11-13T19:08:13Z'
                      description: Test rules
                      id: 3133
                      macro_ids:
                      - 360005374974
                      position: 1
                      prefer_workspace_app_order: true
                      selected_macros:
                      - actions:
                        - field: status
                          value: solved
                        active: true
                        created_at: '2018-02-08T23:45:30Z'
                        description: null
                        id: 360005374974
                        position: 9999
                        restriction:
                          id: 360002226093
                          ids:
                          - 360002226093
                          type: Group
                        title: Close and redirect to topics
                        updated_at: '2018-11-08T22:27:00Z'
                        url: https://{subdomain}.zendesk.com/api/v2/macros/360005374974.json
                        usage_7d: 0
                      ticket_form_id: 360000014173
                      title: Test Workspace 1
                      updated_at: '2018-12-17T22:37:40Z'
                      url: https://{subdomain}.zendesk.com/api/v2/workspaces.json
    delete:
      operationId: DeleteWorkspace
      tags:
      - Workspaces
      summary: Zendesk Delete  Api V2 Workspaces Workspace_id
      description: '#### Allowed For

        * Admins

        '
      responses:
        '204':
          description: No Content
  /api/v2/workspaces/destroy_many:
    delete:
      operationId: DestroyManyWorkspaces
      tags:
      - Workspaces
      summary: Zendesk Delete  Api V2 Workspaces Destroy_many
      description: '#### Allowed For

        * Admins

        '
      parameters:
      - name: ids
        in: query
        description: The ids of the workspaces to delete
        required: true
        schema:
          type: array
          items:
            type: integer
        example:
        - 1
        - 2
        - 3
      responses:
        '200':
          description: Succesful response
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
  /api/v2/workspaces/reorder:
    put:
      operationId: ReorderWorkspaces
      tags:
      - Workspaces
      summary: Zendesk Put  Api V2 Workspaces Reorder
      description: '#### Allowed For

        * Admins

        '
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: number
            examples:
              default:
                value:
                  ids:
                  - 12
                  - 32
                  - 48
                  - 60
      responses:
        '200':
          description: Succesful response
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
components:
  schemas:
    WorkspaceResponse:
      type: object
      allOf:
      - type: object
        properties:
          workspaces:
            type: array
            items:
              $ref: '#/components/schemas/WorkspaceObject'
      - $ref: '#/components/schemas/OffsetPaginationObject'