Skip to content
Docs

Retrieve the profile

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

GETapi.lempile.com/users/me

The account's own X profile as X's Edit profile window and Change username page show it (Unipile's AccountOwnerProfile fields where it has them). The browser reads them and presses nothing: it's a dry run of the edit. Empty fields are null. When X shows another handle than Lempile has on record, the record follows. On a LinkedIn account this is LinkedIn's own profile read.

Scope: accounts.read.

Authentication

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

Query parameters

  • account_idstringrequired

    The connected X account: its Lempile id, its X user id, or its handle.

Responses

200

The profile.

›

application/json

  • objectany
    AlwaysAccountOwnerProfile
  • providerany
    AlwaysX
  • account_idstring
  • namestring | null
  • usernamestring | null
  • public_identifierstring | null
  • public_profile_urlstring | null
  • biostring | null
  • locationstring | null
  • websitestring | null
  • profile_picture_urlstring | null
  • cover_picture_urlstring | null
  • can_change_usernameboolean | null

    false when X's Change username page shows no Username field or asks for the password.

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…

422

errors/profile_field_not_found or errors/x_app_not_loaded: X's Edit profile didn't show.

›

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…

423

errors/x_account_locked: X shows the account its lock page (x.com/account/access). Nothing was done; someone has to pass X's check.

›

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…

503

errors/service_unavailable (the account isn't ready, or the browser runner can't be reached), errors/no_client_session, or errors/maintenance with retry_at.

›

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…

504

errors/timeout: nothing was changed; try again.

›

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?