Skip to main content
POST
apps.connection.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
app
string
required

The app id, lowercase, like "gmail" or "googlecalendar".

Pattern: ^[a-z0-9_-]{1,64}$
redirectUrl
string
required

Where the end user returns to after connecting: a public URL, or http on localhost for a local install.

access
enum<string>

How much of the end user's account to ask for: "read" to look only, "read-write" to look and change. Leave out for the app's standard access. Refused when the app does not offer that level.

Available options:
read,
read-write

Response

The result

connectUrl
string
required

Send the end user here to sign in to the app.

expiresAt
string

When the link stops working, ISO 8601.