Skip to main content
GET
Start an authorization

Query Parameters

response_type
enum<string>
required
Available options:
code
client_id
string
required
Example:

"ofext_live_0123456789abcdef0123456789abcdef"

redirect_uri
string<uri>
required

Must exactly match the registered redirect URI.

scope
string
required

Space separated scopes. Supported: analytics:read, finances:read, lists:read, lists:write, messages:read, messages:write, notifications:read, notifications:write, posts:read, posts:write, profile:read, profile:write, promotions:read, promotions:write, queue:read, queue:write, stories:read, stories:write, subscribers:read, subscribers:write, subscriptions:read, subscriptions:write, users:read, users:write, vault:read, vault:write, identity:read, offline_access.

Example:

"profile:read offline_access"

state
string
required

Opaque value returned on the redirect.

code_challenge
string
required

PKCE challenge (RFC 7636).

code_challenge_method
enum<string>
required
Available options:
S256
linked_account_ids
string

Live only. Comma-separated linked account ids (at most 25) that belong to the same person: after they reconnect, these accounts are grouped under the person who reconnects.

resource
string<uri>

Not needed. Accepted only for OAuth client libraries that always send a resource indicator (RFC 8707): it must equal https://api.ofauth.com/v3 and is not stored.

Response

Redirect to the OFAuth consent screen.