Start OAuth flow
Returns an auth_url and binds the initiating API key, exact dashboard session (when applicable), and workspace grant to one-time OAuth state. workspace_id is required only when Require Workspace ID is enabled.
Authorization
Bearer API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.
In: header
Path Parameters
OAuth platform to connect
Value in
- "twitter"
- "instagram"
- "facebook"
- "linkedin"
- "tiktok"
- "youtube"
- "pinterest"
- "reddit"
- "threads"
- "snapchat"
- "googlebusiness"
- "mastodon"
Query Parameters
Workspace for the connected account. Required only when the organization has Require Workspace ID enabled. In optional mode, omission creates a new organization-scoped identity or preserves an existing identity's current scope on reconnect.
1 <= lengthURL to redirect after OAuth completes
uriAuth method variant (e.g. "direct" for Instagram Login instead of Facebook Login)
Set to "true" for headless mode (returns data instead of redirecting)
Required for Mastodon. Public HTTPS origin of the account's home instance (for example, https://mastodon.social). Paths, credentials, queries, fragments, and private network destinations are rejected.
uriResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/connect/twitter"{ "auth_url": "http://example.com", "temp_token": "string"}Found something wrong? Help us improve this page.