Skip to content
Docs

List accounts

GETdirect.lempile.com/api/v1/accounts

The LinkedIn accounts of this key's workspace, with their status (total_count and status_counts count those only). An account Direct never checked is checked once (one LinkedIn call).

Authentication

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

Query parameters

  • limitinteger

    Items per page: 1 to 250 (default 100).

    Default100≥ 1 · ≤ 250
  • cursorstring

    A cursor a previous page gave.

Responses

200

OK

›

application/json

  • objectstringrequired
    AlwaysAccountList
  • itemsarray of Accountrequired
    ›Show fields
    • objectstringrequired
      AlwaysAccount
    • typestringrequired
      AlwaysLINKEDIN
    • idstringrequired

      The account id: a Lempile account id. Every other route names it as account_id.

    • namestringrequired

      The member's name on LinkedIn (empty until the first check).

    • created_atstringrequired

      When Direct started serving the account.

    • connection_paramsobjectrequired
      ›Show fields
      • imobjectrequired
        ›Show fields
        • idstringrequired

          The member's LinkedIn provider id (ACo…).

        • publicIdentifierstringrequired

          The member's public identifier (the /in/<…> part).

        • usernamestringrequired

          The member's name.

        • premiumIdnullrequired
        • premiumContractIdnullrequired
        • premiumFeaturesarray of stringrequired

          ["premium"] for a Premium member, else [].

        • organizationsarray of objectrequired

          Always [].

    • groupsarray of objectrequired

      Always [].

    • sourcesarray of objectrequired

      One source, as Unipile's LinkedIn accounts have.

      ›Show fields
      • idstringrequired

        <account id>_MESSAGING.

      • statusstringrequired

        OK: LinkedIn answered the account's last call. CREDENTIALS: LinkedIn refused its session (signed out, a security check). ERROR: the account's browser or proxy gave no working session twice over 10 minutes. CONNECTING: not checked yet.

        One ofOKCONNECTINGCREDENTIALSERROR
  • cursorstring | nullrequired

    The next page's cursor, or null on the last page. Opaque: send it back as cursor.

  • total_countintegerrequired

    How many accounts this key sees.

  • status_countsobjectrequired

    Accounts by status (STOPPED is always 0).

    ›Show fields
    • OKintegerrequired
    • CONNECTINGintegerrequired
    • CREDENTIALSintegerrequired
    • STOPPEDintegerrequired
    • ERRORintegerrequired
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.

Was this page helpful?