Build hosted OAuth authorization URL with PKCE

post/oauth/authorization-start

Request

  • Base URL: https://api.gravityads.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.gravityads.dev/oauth/authorization-start
  • Auth: HTTP bearer

Request body

platform'google' | 'meta' | 'microsoft' | 'bing' | 'tiktok' | 'pinterest' | 'linkedin' required
redirect_uristring uri required
client_idstring

Hosted OAuth app client id. Prefer env in production.

connection_idstring
account_hintstring
access_mode'read_only' | 'controlled_write'
scopesstring[]
authorization_purpose'standard' | 'new_creative' | 'page_discovery' | 'instagram_identity' | 'threads_identity'

Meta controlled_write purposes: new_creative adds pages_read_engagement and pages_show_list; identity discovery also requests pages_manage_ads for promote_pages, with instagram_basic and threads_business_basic added by the selected identity purpose.

Response

OAuth authorization URL

schema_version'gravityads.hosted_oauth_authorization_start.v1' required
status'oauth_authorization_start_ready' required
tenant_idstring required
platformstring required
connection_idstring required
authorization_urlstring required
statestring required
state_claimsobject
scopesstring[] required
authorization_purpose'standard' | 'new_creative' | 'page_discovery' | 'instagram_identity' | 'threads_identity'
access_mode'read_only' | 'controlled_write'
developer_token_required_in_connectorboolean
writes_platformfalse required
raw_token_forwarded_to_adapterfalse required

Changes

No recorded changes to this operation across all 1 revision of this API.