Skip to main content
POST
Get a connect URL

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

provider
string
required

The provider to connect, as named in Ergoly's provider registry. An unknown one is a 400.

Body

application/json
key
string
required

The key the connected account will be stored under.

scope
enum<string>

Which identities will resolve the account. Defaults to org.

Available options:
org,
worker,
client
workerId
string

Required when scope is worker.

clientId
string

Required when scope is client.

providerScopes
string[]

Extra provider scopes, unioned with the provider app's defaults.

A provider OAuth scope.

Response

Success.

data
object
required