Skip to main content
POST
/
api
/
v1
/
connected-accounts
/
auth-link
Create Auth Link
curl --request POST \
  --url https://api.example.com/api/v1/connected-accounts/auth-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "linkedin",
  "return_path": "<string>"
}
'
{
  "url": "<string>",
  "provider": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to generate a hosted auth link for account connection.

​
provider
enum<string>
default:linkedin

Provider to connect

Available options:
linkedin
​
return_path
string | null

Relative path to redirect after auth (e.g. '/onboarding?step=connect'). Must start with '/'. If omitted, defaults to '/dashboard/connected-accounts'.

Maximum string length: 512

Response

Successful Response

Response containing the hosted auth URL.

​
url
string
required

Redirect URL for account connection

​
provider
string
required