v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-01-027446226.6 KB
dialpad-oauth

Authorize Dialpad

Start Dialpad 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
  • code_challenge: PKCE code challenge for enhanced security
  • code_challenge_method: PKCE code challenge method
get/oauth/dialpad/authorize

Query parameters

instance_idstring required

Unique identifier for the client instance requesting authorization

Unique identifier for the client instance requesting authorization

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

code_challengestring nullable

PKCE code challenge for enhanced security

PKCE code challenge for enhanced security

code_challenge_methodstring nullable

PKCE code challenge method (default: S256)

PKCE code challenge method (default: S256)

Response

Successful Response

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