Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-012124381.2 MB
zendesk-oauth

Authorize Zendesk

Start Zendesk OAuth flow

Parameters:

  • instance_id: Identifier for the instance requesting authorization
  • client_id: Optional client ID for white labeling
  • scope: Optional scopes to request (space-separated)
  • redirect_url: Optional URL to redirect to after authorization completes
  • subdomain: Zendesk subdomain for the account being connected
get/oauth/zendesk/authorize

Query parameters

instance_idstring required

Unique identifier for the client instance requesting authorization

Unique identifier for the client instance requesting authorization

subdomainstring required

Zendesk subdomain for the account being connected (e.g., 'mycompany' for mycompany.zendesk.com)

Zendesk subdomain for the account being connected (e.g., 'mycompany' for mycompany.zendesk.com)

client_idstring nullable

Client ID for white labeling, if not provided will use default credentials

Client ID for white labeling, if not provided will use default credentials

scopestring nullable

Optional OAuth scopes to request (space-separated string)

Optional OAuth scopes to request (space-separated string)

redirect_urlstring nullable

Optional URL to redirect to after authorization completes

Optional URL to redirect to after authorization completes

Response

Successful Response

{"stackTrail":"paths:/oauth/zendesk/authorize:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}