Skip to content
Docs

Retrieve an account

Early access. Tell us what you're building and we'll set you up. Contact us

GETapi.lempile.com/accounts/{account_id}

One account, in Unipile's shape. sources[].status is OK (ready), CREDENTIALS (sign-in or a check needed), CONNECTING or ERROR. No browser opens.

Scope: accounts.read.

Authentication

X-API-KEY header·A Lempile API key, made in the dashboard under Access tokens.

Path parameters

  • account_idstringrequired

    Lempile id, X user id or handle.

Responses

200

The account.

›

application/json

  • objectany
    AlwaysAccount
  • idstring
  • typeany
    AlwaysX
  • namestring
  • created_atstring · date-time
  • sourcesarray of object
    ›Show fields
    • idstring
    • statusstring
      One ofOKCREDENTIALSCONNECTINGERROR
401

Missing or invalid API key ({error, message}), errors/disconnected_account, or errors/reauth_required when X is signed out in the account's browser.

›

application/problem+json

  • typestringrequired
  • titlestring
  • statusintegerrequired
  • detailstring
  • retry_atstring · date-time
  • codestring

    The browser's own reason, when it refused before the click: replies_limited, post_not_accepted, gif_not_found, browser_busy…

402

subscription_required: the workspace has no active trial or subscription.

›

application/problem+json

  • typestringrequired
  • titlestring
  • statusintegerrequired
  • detailstring
  • retry_atstring · date-time
  • codestring

    The browser's own reason, when it refused before the click: replies_limited, post_not_accepted, gif_not_found, browser_busy…

404

errors/resource_not_found: no such account in this workspace, or it isn't an X account.

›

application/problem+json

  • typestringrequired
  • titlestring
  • statusintegerrequired
  • detailstring
  • retry_atstring · date-time
  • codestring

    The browser's own reason, when it refused before the click: replies_limited, post_not_accepted, gif_not_found, browser_busy…

Was this page helpful?