Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
toolkit
string
required

App slug from the catalog (e.g. gmail)

callback_url
string

Where to return the user after auth

scope
enum<string>
default:account

Who owns the resulting connection. account (default) shares it with the whole workspace; user makes it personal to the authenticated user and invisible to teammates.

Available options:
account,
user

Response

Success

object
enum<string>
required
Available options:
connection_link
status
enum<string>
required
Available options:
INITIATED
toolkit
string
required
redirect_url
string
required

Hosted OAuth URL to send the user to

external_account_id
string
expires_at
string | null