Zendesk

Zendesk SLA Policies API

The SLA Policies API from Zendesk — 4 operation(s) for sla policies.

Documentation GitHub OpenAPI

Documentation

https://developer.zendesk.com/api-reference/ticketing/introduction/

https://developer.zendesk.com/api-reference/ticketing/targets/targets/

https://developer.zendesk.com/api-reference/sales-crm/resources/account/

https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/

https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/

https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/

https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/

https://developer.zendesk.com/api-reference/custom-data/introduction/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/

https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/

https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/

https://developer.zendesk.com/api-reference/ticketing/users/users/

https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/

https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/

https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/

https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/

https://developer.zendesk.com/api-reference/ticketing/groups/groups/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/

https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/

https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/

https://developer.zendesk.com/api-reference/ticketing/lookup_relationships/lookup_relationships/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/

https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/

https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/

https://developer.zendesk.com/api-reference/ticketing/business-rules/views/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/zendesk-sla-policies-api-openapi.yml

Schemas & Data

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

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

Other Resources

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

OpenAPI Specification

openapi: 3.1.0
info:
  version: '1.0'
  title: Zendesk Account Account Settings SLA Policies API
  description: Needs a description.
tags:
- name: SLA Policies
paths:
  /api/v2/slas/policies:
    get:
      operationId: ListSLAPolicies
      tags:
      - SLA Policies
      summary: Zendesk Get  Api V2 Slas Policies
      description: '#### Availability


        * Accounts on the Support Professional or Suite Growth plan or above


        #### Allowed For


        * Admins

        '
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SLAPoliciesResponse'
              examples:
                default:
                  $ref: '#/components/examples/SLAPoliciesResponseExample'
    post:
      operationId: CreateSLAPolicy
      tags:
      - SLA Policies
      summary: Zendesk Post  Api V2 Slas Policies
      description: '#### Availability


        * Accounts on the Support Professional or Suite Growth plan or above


        #### Allowed For


        * Admins

        '
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SLAPolicyResponse'
              examples:
                default:
                  $ref: '#/components/examples/SLAPolicyCreateResponse'
  /api/v2/slas/policies/{sla_policy_id}:
    parameters:
    - $ref: '#/components/parameters/SLAPolicyId'
    get:
      operationId: ShowSLAPolicy
      tags:
      - SLA Policies
      summary: Zendesk Get  Api V2 Slas Policies Sla_policy_id
      description: '#### Availability


        * Accounts on the Support Professional or Suite Growth plan or above


        #### Allowed For


        * Admins

        '
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SLAPolicyResponse'
              examples:
                default:
                  $ref: '#/components/examples/SLAPolicyResponseExample'
    put:
      operationId: UpdateSLAPolicy
      tags:
      - SLA Policies
      summary: Zendesk Put  Api V2 Slas Policies Sla_policy_id
      description: 'Updates the specified policy.


        #### Availability


        * Accounts on the Support Professional or Suite Growth plan or above


        #### Allowed For


        * Admins

        '
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SLAPolicyResponse'
              examples:
                default:
                  $ref: '#/components/examples/SLAPolicyUpdateResponse'
    delete:
      operationId: DeleteSLAPolicy
      tags:
      - SLA Policies
      summary: Zendesk Delete  Api V2 Slas Policies Sla_policy_id
      description: '#### Availability


        * Accounts on the Support Professional or Suite Growth plan or above


        #### Allowed For


        * Admins

        '
      responses:
        '204':
          description: No Content response
  /api/v2/slas/policies/definitions:
    get:
      operationId: RetrieveSLAPolicyFilterDefinitionItems
      tags:
      - SLA Policies
      summary: Zendesk Get  Api V2 Slas Policies Definitions
      description: '#### Availability


        * Accounts on the Support Professional or Suite Growth plan or above


        #### Allowed For


        * Admins

        '
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SLAPolicyFilterDefinitionResponse'
              examples:
                default:
                  $ref: '#/components/examples/SLAPolicyFilterDefinitionResponseExample'
  /api/v2/slas/policies/reorder:
    put:
      operationId: ReorderSLAPolicies
      tags:
      - SLA Policies
      summary: Zendesk Put  Api V2 Slas Policies Reorder
      description: '#### Availability


        * Accounts on the Support Professional or Suite Growth plan or above


        #### Allowed For


        * Admins

        '
      parameters:
      - name: sla_policy_ids
        in: query
        description: The IDs of the SLA Policies to reorder
        schema:
          type: array
          items:
            type: integer
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
components:
  schemas:
    SLAPoliciesResponse:
      type: object
      properties:
        count:
          type: integer
          readOnly: true
        next_page:
          type: string
          nullable: true
          readOnly: true
        previous_page:
          type: string
          nullable: true
          readOnly: true
        sla_policies:
          type: array
          items:
            $ref: '#/components/schemas/SLAPolicyObject'
    SLAPolicyFilterDefinitionResponse:
      type: object
      properties:
        definitions:
          type: object
          properties:
            all:
              type: array
              items:
                type: object
                properties:
                  group:
                    type: string
                  operators:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        value:
                          type: string
                  target:
                    type: string
                    nullable: true
                  title:
                    type: string
                  value:
                    type: string
                  values:
                    type: object
                    properties:
                      list:
                        type: array
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                            value:
                              type: string
                              nullable: true
                      type:
                        type: string
            any:
              type: array
              items:
                type: object
                properties:
                  group:
                    type: string
                  operators:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        value:
                          type: string
                  target:
                    type: string
                    nullable: true
                  title:
                    type: string
                  value:
                    type: string
                  values:
                    type: object
                    properties:
                      list:
                        type: array
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                            value:
                              type: string
                              nullable: true
                      type:
                        type: string
    SLAPolicyResponse:
      type: object
      properties:
        sla_policy:
          $ref: '#/components/schemas/SLAPolicyObject'