List relations

GETdirect.lempile.com/api/v1/users/relations

The account's connections, newest first (100 a LinkedIn call).

Authentication

X-API-KEY header·A Lempile Direct key, one per workspace, made in Lempile's dashboard.

Query parameters

account_idstringrequirede.g. 00000000-0000-4000-8000-0000000000a1
The account that reads: a Lempile LinkedIn account id (GET /accounts lists them).
limitinteger
Items per page: 1 to 1000 (default 100).
Default100≥ 1 · ≤ 1000
cursorstring
A cursor a previous page gave.
filterstring
Answers 501: filtering by name isn't done yet.

Responses

200

›

application/json

objectstringrequired
AlwaysUserRelationsList
itemsarray of UserRelationrequired
›Show fieldsHide fields
- objectstringrequired
  AlwaysUserRelation
- first_namestringrequired
- last_namestringrequired
- headlinestringrequired
- public_identifierstringrequired
- public_profile_urlstringrequired
- created_atintegerrequired
  When the connection was made, in milliseconds since 1970.
- member_idstringrequired
  The relation's provider id (ACo…).
- member_urnstringrequired
- connection_urnstringrequired
- profile_picture_urlstring
cursorstring | nullrequired
The next page's cursor, or null on the last page. Opaque: send it back as cursor.

400

A required parameter missing (errors/missing_parameters), or one that isn't valid (errors/invalid_parameters, errors/invalid_url, errors/content_too_large).

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

401

errors/missing_credentials: the X-API-KEY header is missing, wrong or revoked. errors/disconnected_account: LinkedIn signed the account out (or asks it for a security check); reconnect it.

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

404

errors/resource_not_found: an unknown or removed account, an account of another workspace (answered exactly the same), or nothing on LinkedIn with this id.

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

429

errors/too_many_requests: LinkedIn asked the account to slow down (it rests 15 minutes), its daily calls or writes are used up, or it's busy with other calls. Wait retry_after seconds.

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

500

errors/provider_error: LinkedIn answered something Direct couldn't read (nothing was written). errors/unexpected_error: Direct failed.

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

501

errors/feature_not_implemented: Direct doesn't do this (yet). A Unipile client can fall back to Unipile.

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

503

errors/network_down: the account's proxy or browser server didn't answer. Nothing was sent.

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

504

errors/request_timeout: LinkedIn didn't answer in time. On a write: an unknown outcome (it may have been sent); it's never retried and its Idempotency-Key never writes again.

›

application/json

titlestringrequired
A short title, e.g. Too many requests.
detailstringrequired
What happened, in plain words. Never an account's data.
typestringrequired
Unipile's error type: errors/<kind>. Branch on this, not on detail.
statusintegerrequired
The HTTP status again.
retry_afterinteger
Seconds to wait before trying this account again. Only on 429; the Retry-After header carries the same value.

Was this page helpful?