Skip to main content
POST
Hosted Auth Link
Returns a HostedAuthUrl that you send the end user to. They complete the LinkedIn sign-in on Unipile’s hosted page, so no credentials ever touch your system. Managed mode (recommended): omit notify_url and AISA handles everything — poll GET /apis/v1/unipile/me/accounts until the account appears (usually within seconds of the user finishing the wizard); no webhook infrastructure needed on your side. Self-hosted mode: pass your own notify_url and Unipile POSTs {"status":"CREATION_SUCCESS","account_id":"…","name":"…"} to it when the flow completes — store that account_id, it is the identifier every other endpoint requires, and with your own webhook there is no listing endpoint to re-discover it (managed-mode users read me/accounts instead). The name you set here is echoed back in self-hosted mode, so use it to map the account to your own user. Reply 200 within 30 seconds or the event is retried five times; consider verifying a shared-secret header on your endpoint. Links expire on Unipile’s daily restart regardless of expiresOn, so generate a fresh link each time a user wants to connect. Note: re-authorizing the same LinkedIn account creates a new account_id; earlier bindings remain listed until disconnected. Reference price: $0.000001 USD per successful request.

Example

Path parameters and required query parameters are documented in the operation reference.

Authorizations

Authorization
string
header
required

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

Body

application/json
type
enum<string>
required

create connects a new account, reconnect re-authenticates an existing one.

Available options:
create,
reconnect
providers
string[]
required

Provider list, for example ["LINKEDIN"]. Only used with type=create.

api_url
string
required

The Unipile server URL of this AIsa binding, for example https://api68.unipile.com:19823. Use the value documented here; a generic Unipile URL will not match the binding.

expiresOn
string
required

ISO 8601 UTC expiry, for example 2026-12-31T23:59:59.999Z. Required by upstream, even though links also die on Unipile's daily restart.

name
string

Label echoed back in events so you can match the account to your own user.

notify_url
string

Callback notified once the connection completes.

success_redirect_url
string

Browser redirect after a successful connection.

failure_redirect_url
string

Browser redirect after a failed connection.

reconnect_account
string

Account id to re-authenticate. Required when type is reconnect.

bypass_success_screen
boolean

Skip Unipile's hosted success screen before the browser follows success_redirect_url.

disabled_features
string[]

Provider features to disable on the connected account: linkedin_recruiter, linkedin_sales_navigator, or linkedin_organizations_mailboxes.

Response

Success

object
enum<string>
Available options:
HostedAuthUrl
url
string

Hosted authorization URL to send the user to.