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. When the flow finishes your notify_url receives the new account_id, which is what every other endpoint needs. Generate a fresh link per attempt: links also expire on Unipile’s daily restart regardless of expiresOn. 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"].

api_url
string
required

Your Unipile server URL, for example https://{subdomain}.unipile.com:{port}.

expiresOn
string

ISO 8601 UTC expiry, for example 2026-12-31T23:59:59.999Z.

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.

Response

Success

object
enum<string>
Available options:
HostedAuthUrl
url
string

Hosted authorization URL to send the user to.