Connection Sessions

A connection session is a short-lived link that opens the Linked API connection page, where the end user logs into LinkedIn. Use it to connect a new account or to reconnect one whose LinkedIn session has expired. For the accounts themselves, see Accounts.

accounts.createConnectionSession

Create a new connection session to connect a LinkedIn account. Returns a link that opens the connection page where the user logs into LinkedIn.

curl -X POST https://api.linkedapi.io/admin/accounts.createConnectionSession \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"

Body:

The body is optional. Send no body at all to get the default behavior, or pass completion to control what the user sees after a successful connection – see Customizing the completion screen.

Field	Type	Required	Description
`completion`	`object`	No	Post-connection behavior of the connection page

Response:

json

{
  "success": true,
  "result": {
    "sessionId": "990eef7a-...",
    "connectionLink": "https://app.linkedapi.io/connection/990eef7a-..."
  }
}

Field	Type	Description
`sessionId`	`string`	Session UUID for tracking
`connectionLink`	`string`	URL to open in a browser to complete the LinkedIn login

Errors:

Type	Description
`subscriptionRequired`	No subscription with a seat yet – buy seats with subscription.setSeats first
`noAvailableSeats`	No available seats – all seats are occupied by active accounts or pending connection sessions
`dailyConnectionAttemptsExceeded`	Too many connection attempts in the last 24 hours
`invalidRequestPayload`	The `completion` object is malformed – the message names the offending field

Flow: Create session → open connectionLink → user logs into LinkedIn → poll accounts.getConnectionSession until status is success → account appears in accounts.getAll.

The whole flow over HTTP – create the session, check it until it leaves the in-progress statuses, then read the accounts:

# 1. Create the session and open the returned connectionLink in a browser
curl -X POST https://api.linkedapi.io/admin/accounts.createConnectionSession \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"

# 2. After the user logs into LinkedIn, check the session until status is "success"
curl -X POST https://api.linkedapi.io/admin/accounts.getConnectionSession \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here" \
  -d '{"sessionId": "<sessionId>"}'

# 3. Verify the account appeared
curl -X POST https://api.linkedapi.io/admin/accounts.getAll \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here"

// 1. Create a connection session
const { sessionId, connectionLink } = await admin.accounts.createConnectionSession();
console.log('Open this link to connect:', connectionLink);

// 2. Poll until the session completes
const POLL_INTERVAL_MS = 3000;
const MAX_WAIT_MS = 2 * 60 * 1000;
const deadline = Date.now() + MAX_WAIT_MS;
const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
const inProgressStatuses = ['pending', 'preparing', 'serving', 'streaming'];

let session;

do {
  if (Date.now() >= deadline) {
    throw new Error('Timed out waiting for connection session completion');
  }

  await sleep(POLL_INTERVAL_MS);
  ({ session } = await admin.accounts.getConnectionSession({ sessionId }));
} while (inProgressStatuses.includes(session.status));

if (session.status === 'success') {
  // 3. Get the new account details
  const { accounts } = await admin.accounts.getAll();
  console.log('Total accounts:', accounts.length);
}

import time

from linkedapi import GetConnectionSessionParams

# 1. Create a connection session
created = admin.accounts.create_connection_session()
print("Open this link to connect:", created.connection_link)

# 2. Poll until the session completes
POLL_INTERVAL_SECONDS = 3
MAX_WAIT_SECONDS = 2 * 60
deadline = time.monotonic() + MAX_WAIT_SECONDS
in_progress_statuses = {"pending", "preparing", "serving", "streaming"}

while True:
    if time.monotonic() >= deadline:
        raise TimeoutError("Timed out waiting for connection session completion")

    time.sleep(POLL_INTERVAL_SECONDS)
    session = admin.accounts.get_connection_session(
        GetConnectionSessionParams(session_id=created.session_id)
    ).session
    if session.status not in in_progress_statuses:
        break

if session.status == "success":
    # 3. Get the new account details
    accounts = admin.accounts.get_all().accounts
    print("Total accounts:", len(accounts))

# 1. Create the session and open the printed connectionLink in a browser
linkedin admin accounts connect

# 2. After the user logs into LinkedIn, check the session until status is "success"
linkedin admin accounts session <sessionId> --json

# 3. Verify the account appeared
linkedin admin accounts list

accounts.createReconnectionSession

Create a new reconnection session for an account whose status is reconnection_required. If the account already has an active reconnection session, it is cancelled and replaced with a new one. If an in-progress reconnection session is applying a pending proxy change, Linked API returns that existing session instead so the proxy change state is preserved.

curl -X POST https://api.linkedapi.io/admin/accounts.createReconnectionSession \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here" \
  -d '{"accountId": "a91c20f8-..."}'

Body:

Field	Type	Required	Description
`accountId`	`string`	Yes	UUID of the account to reconnect
`completion`	`object`	No	Post-connection behavior of the connection page – see Customizing the completion screen

Response:

json

{
  "success": true,
  "result": {
    "reconnectionSessionId": "d90ac1f6-...",
    "reconnectionLink": "https://app.linkedapi.io/connection/d90ac1f6-..."
  }
}

Field	Type	Description
`reconnectionSessionId`	`string`	Session UUID for tracking
`reconnectionLink`	`string`	URL to open in a browser to complete LinkedIn reconnection

Errors:

Type	Description
`invalidRequestPayload`	The account is not in `reconnection_required` status or cannot be reconnected

Flow: Create reconnection session → open reconnectionLink → user logs into LinkedIn → poll accounts.getConnectionSession with reconnectionSessionId until status is success.

The same flow in the CLI:

bash

# 1. Find accounts that require reconnection – they carry a reconnectionLink
linkedin admin accounts list

# 2. Create a fresh reconnection session if you need to replace the link
linkedin admin accounts reconnect <accountId>

# 3. Open the printed reconnectionLink, complete the LinkedIn login, then check the session
linkedin admin accounts session <reconnectionSessionId> --json

accounts.getConnectionSession

Check the status of a connection session.

curl -X POST https://api.linkedapi.io/admin/accounts.getConnectionSession \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here" \
  -d '{"sessionId": "990eef7a-..."}'

Body:

Field	Type	Required	Description
`sessionId`	`string`	Yes	Session UUID

Response:

json

{
  "success": true,
  "result": {
    "session": {
      "sessionId": "990eef7a-...",
      "status": "pending",
      "type": "initial"
    }
  }
}

Session statuses:

Status	Description
`pending`	Session created, waiting for user to open the link
`preparing`	Browser is being provisioned
`serving`	Browser is ready, waiting for user to connect
`streaming`	User is connected and logging in
`success`	Login completed, account is being created
`expired`	Session timed out
`error`	An error occurred
`cancelled`	Session was cancelled

accounts.cancelConnectionSession

Cancel an active connection session.

curl -X POST https://api.linkedapi.io/admin/accounts.cancelConnectionSession \
  -H "Content-Type: application/json" \
  -H "linked-api-token: linked_your_token_here" \
  -d '{"sessionId": "990eef7a-..."}'

Body:

Field	Type	Required	Description
`sessionId`	`string`	Yes	Session UUID

Response:

json

{
  "success": true,
  "result": {}
}

PreviousAccounts NextCompletion Screen