Skip to main content
POST
linkedin.account.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$

Response

The result

connected
boolean
required

True when the end user's LinkedIn account is connected and usable.

status
enum<string>

How the connection stands: "connected" to use it now, "needs_attention" when the end user must sign in again, "disconnected" when it is stopped, "pending" while the connection is in progress.

Available options:
connected,
needs_attention,
disconnected,
pending
connectedAt
string

When the account was connected, ISO 8601.