{"openapi":"3.1.0","info":{"title":"Zendesk (BYOK) API","version":"0.1.0","description":"Zendesk (BYOK) lets an AI assistant read your own Zendesk data through the Zendesk API with a key you supply (agent email address followed by /token, for example you@example.com/token). Read-only: 7 tools (list_tickets, get_ticket, list_ticket_comments, search_zendesk, list_users, get_current_user, list_organizations). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-zendesk.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-zendesk/docs"},"termsOfService":"https://connectorbay.com/byok-zendesk/terms"},"servers":[{"url":"https://byok-zendesk.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-zendesk/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_tickets":{"post":{"operationId":"list_tickets","summary":"List tickets (archived ones excluded) with subject, status, priority, type, requester, assignee, organization, tags and ","description":"List tickets (archived ones excluded) with subject, status, priority, type, requester, assignee, organization, tags and dates, 100 per page at most; follow meta.after_cursor for more. Use for \"Which Zendesk tickets were updated most recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Zendesk subdomain: the part before .zendesk.com, for example 'mycompany' for mycompany.zendesk.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many records to return (1 to 100).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: meta.after_cursor from the previous answer, used while meta.has_more is true. Leave out for the first page.","title":"Page After"},"sort":{"anyOf":[{"enum":["id","-id","updated_at","-updated_at","status","-status"],"type":"string"},{"type":"null"}],"default":"-updated_at","description":"Sort by id, updated_at or status; a leading - sorts descending, for example -updated_at.","title":"Sort"},"external_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only tickets with this external id.","title":"External Id"}},"required":["subdomain"],"title":"list_ticketsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_ticket":{"post":{"operationId":"get_ticket","summary":"Get one ticket by id with subject, first comment text, status, priority, requester, assignee, organization, tags and dat","description":"Get one ticket by id with subject, first comment text, status, priority, requester, assignee, organization, tags and dates. Use for \"Show Zendesk ticket 35436\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Zendesk subdomain: the part before .zendesk.com, for example 'mycompany' for mycompany.zendesk.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"ticket_id":{"description":"The ticket id, for example 35436.","minimum":1,"title":"Ticket Id","type":"integer"}},"required":["subdomain","ticket_id"],"title":"get_ticketArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_ticket_comments":{"post":{"operationId":"list_ticket_comments","summary":"List the comments of one ticket in order, with plain-text body, whether public, author id, time and channel; follow meta","description":"List the comments of one ticket in order, with plain-text body, whether public, author id, time and channel; follow meta.after_cursor for more. Use for \"What was said on Zendesk ticket 35436\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Zendesk subdomain: the part before .zendesk.com, for example 'mycompany' for mycompany.zendesk.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"ticket_id":{"description":"The ticket id, for example 35436.","minimum":1,"title":"Ticket Id","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many records to return (1 to 100).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: meta.after_cursor from the previous answer, used while meta.has_more is true. Leave out for the first page.","title":"Page After"},"sort":{"anyOf":[{"enum":["created_at","-created_at"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Sort by created_at (oldest first) or -created_at (newest first).","title":"Sort"}},"required":["subdomain","ticket_id"],"title":"list_ticket_commentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_zendesk":{"post":{"operationId":"search_zendesk","summary":"Search tickets, users, organizations or groups with Zendesk search syntax such as 'status:open priority:high'; returns c","description":"Search tickets, users, organizations or groups with Zendesk search syntax such as 'status:open priority:high'; returns common fields of each hit, 100 per page at most; follow meta.after_cursor for more. Use for \"Find open high priority Zendesk tickets\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Zendesk subdomain: the part before .zendesk.com, for example 'mycompany' for mycompany.zendesk.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"query":{"description":"Zendesk search query, for example 'status:open priority:high' or 'jane@example.com'. Do not put type: in it; use the type parameter.","maxLength":500,"title":"Query","type":"string"},"type":{"description":"What to search for: ticket, organization, user or group.","enum":["ticket","organization","user","group"],"title":"Type","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many records to return (1 to 100).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: meta.after_cursor from the previous answer, used while meta.has_more is true. Leave out for the first page.","title":"Page After"}},"required":["subdomain","query","type"],"title":"search_zendeskArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_users":{"post":{"operationId":"list_users","summary":"List users (end users, agents and admins) with name, email, role, organization, active and verified flags, last login an","description":"List users (end users, agents and admins) with name, email, role, organization, active and verified flags, last login and time zone; follow meta.after_cursor for more. Use for \"Who are the agents in my Zendesk account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Zendesk subdomain: the part before .zendesk.com, for example 'mycompany' for mycompany.zendesk.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many records to return (1 to 100).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: meta.after_cursor from the previous answer, used while meta.has_more is true. Leave out for the first page.","title":"Page After"},"role":{"anyOf":[{"enum":["end-user","agent","admin"],"type":"string"},{"type":"null"}],"default":null,"description":"Only users with this role.","title":"Role"}},"required":["subdomain"],"title":"list_usersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_current_user":{"post":{"operationId":"get_current_user","summary":"Show the Zendesk user the credentials belong to: name, email, role, organization, time zone and last login. Use for \"Whi","description":"Show the Zendesk user the credentials belong to: name, email, role, organization, time zone and last login. Use for \"Which Zendesk user am I logged in as\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Zendesk subdomain: the part before .zendesk.com, for example 'mycompany' for mycompany.zendesk.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"}},"required":["subdomain"],"title":"get_current_userArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_organizations":{"post":{"operationId":"list_organizations","summary":"List organizations with name, domain names, tags, details, notes, default group and dates; follow meta.after_cursor for ","description":"List organizations with name, domain names, tags, details, notes, default group and dates; follow meta.after_cursor for more. Use for \"Which organizations are in my Zendesk account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"subdomain":{"description":"Your Zendesk subdomain: the part before .zendesk.com, for example 'mycompany' for mycompany.zendesk.com.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Subdomain","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many records to return (1 to 100).","title":"Page Size"},"page_after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for the next page: meta.after_cursor from the previous answer, used while meta.has_more is true. Leave out for the first page.","title":"Page After"}},"required":["subdomain"],"title":"list_organizationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}