Zendesk

Zendesk Sharing Agreements API

The Sharing Agreements API from Zendesk — 2 operation(s) for sharing agreements.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/sharing_agreements List ticket sharing agreements · Zendesk Get Api V2 Sharing_agreements #

Ask an LLM

“Which ticket sharing agreements does my account have with other accounts?”

“Can agents see the list of sharing agreements?”

Tell an agent

List all ticket sharing agreements.

Show the sharing agreements set up on my account.

POST /api/v2/sharing_agreements Create a ticket sharing agreement · Zendesk Post Api V2 Sharing_agreements #

Ask an LLM

“How do I set up ticket sharing with another help desk account?”

“Who can create a sharing agreement?”

Tell an agent

Create a new ticket sharing agreement with a partner account.

Set up an agreement to share tickets with another account.

GET /api/v2/sharing_agreements/{sharing_agreement_id} Show a sharing agreement · Zendesk Get Api V2 Sharing_agreements Sharing_agreement_id #

Ask an LLM

“Can I view the details of a single sharing agreement?”

“What status does one ticket sharing agreement have?”

Tell an agent

Show the sharing agreement with that ID.

Fetch the details of one ticket sharing agreement.

PUT /api/v2/sharing_agreements/{sharing_agreement_id} Change a sharing agreement's status · Zendesk Put Api V2 Sharing_agreements Sharing_agreement_id #

Ask an LLM

“Can I accept or decline a pending sharing agreement?”

“Which field of a sharing agreement can be updated?”

Tell an agent

Accept that pending sharing agreement by updating its status.

Set the status of one sharing agreement to inactive.

DELETE /api/v2/sharing_agreements/{sharing_agreement_id} Delete a sharing agreement · Zendesk Delete Api V2 Sharing_agreements Sharing_agreement_id #

Ask an LLM

“Can I end ticket sharing by deleting the agreement?”

“Who is allowed to remove a sharing agreement?”

Tell an agent destructive · confirm first

Delete that ticket sharing agreement.

Remove the sharing agreement with the partner account.

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-sharing-agreements-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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zendesk:zendesk-sharing-agreements-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '1.0'
  title: Zendesk Sharing Agreements API
  description: Needs a description.
tags:
- name: Sharing Agreements
paths:
  /api/v2/sharing_agreements:
    get:
      operationId: ListSharingAgreements
      tags:
      - Sharing Agreements
      summary: Zendesk Get Api V2 Sharing_agreements
      description: '#### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingAgreementsResponse'
              examples:
                default:
                  $ref: '#/components/examples/SharingAgreementsResponseExample'
    post:
      operationId: CreateSharingAgreement
      tags:
      - Sharing Agreements
      summary: Zendesk Post Api V2 Sharing_agreements
      description: '#### Allowed For


        * Admins'
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingAgreementResponse'
              examples:
                default:
                  $ref: '#/components/examples/SharingAgreementResponseExample'
  /api/v2/sharing_agreements/{sharing_agreement_id}:
    parameters:
    - $ref: '#/components/parameters/SharingAgreementId'
    get:
      operationId: ShowSharingAgreement
      tags:
      - Sharing Agreements
      summary: Zendesk Get Api V2 Sharing_agreements Sharing_agreement_id
      description: 'Returns a sharing agreement for your account.


        #### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingAgreementResponse'
              examples:
                default:
                  $ref: '#/components/examples/SharingAgreementResponseExample'
    put:
      operationId: UpdateSharingAgreement
      tags:
      - Sharing Agreements
      summary: Zendesk Put Api V2 Sharing_agreements Sharing_agreement_id
      description: 'Returns an updated sharing agreement. Only `status` is allowed to be updated.


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingAgreementResponse'
              examples:
                default:
                  $ref: '#/components/examples/SharingAgreementUpdateResponseExample'
    delete:
      operationId: DeleteSharingAgreement
      tags:
      - Sharing Agreements
      summary: Zendesk Delete Api V2 Sharing_agreements Sharing_agreement_id
      description: 'Deletes a sharing agreement.


        #### Allowed For


        * Admins'
      responses:
        '204':
          description: No Content response
components:
  schemas:
    SharingAgreementResponse:
      type: object
      properties:
        sharing_agreement:
          $ref: '#/components/schemas/SharingAgreementObject'
    SharingAgreementsResponse:
      type: object
      properties:
        sharing_agreements:
          type: array
          items:
            $ref: '#/components/schemas/SharingAgreementObject'