API Reference/Users/Retrieve own profile

Retrieve own profile

GEThttps://api.postpress.ai/v1/users/me

Retrieve information about the account owner. The shape of the response depends on the provider of the linked account.

Authorization

X-API-KEYstringrequired
API key from your postpress dashboard. Sent as a request header.

Query parameters

account_idstringrequired
The id of the linked account to trigger the request from.

Response 200 OK

The response is one of the following variants, picked based on the account's provider.

LinkedIn variantobject
LinkedIn variant object
objectstringAccountOwnerProfilerequired
providerstringLINKEDINrequired
provider_idstringrequired
entity_urnstringrequired
object_urnstringrequired
first_namestringrequired
last_namestringrequired
profile_picture_urlstringrequired
public_profile_urlstring
public_identifierstring
headlinestring
locationstring
emailstringrequired
premiumbooleanrequired
open_profilebooleanrequired
occupationstring
organizationsarray of objectsrequired
organizations array
idstringrequired
mailbox_idstringrequired
namestringrequired
recruiterobjectrequired
One of the variants below.
recruiter object
Seat variantobject
Seat variant object
owner_seat_idstringrequired
contract_idstringrequired
Error variantobject
Error variant object
errorstringrequired
MULTIPLE_SESSIONSDISCONNECTED
nullnull
Recruiter is not available for this account.
sales_navigatorobjectrequired
One of the variants below.
sales_navigator object
Seat variantobject
Seat variant object
owner_seat_idstringrequired
contract_idstringrequired
Error variantobject
Error variant object
errorstringDISCONNECTEDrequired
nullnull
Sales Navigator is not available for this account.
Telegram variantobject
Telegram variant object
objectstringAccountOwnerProfilerequired
providerstringTELEGRAMrequired
provider_idstringrequired
selfboolean
contactboolean
mutual_contactboolean
deletedboolean
botboolean
verifiedboolean
restrictedboolean
fakeboolean
premiumboolean
close_friendboolean
first_namestring
last_namestring
usernamestring
phonestring
profile_picture_urlstringrequired
statusobject
status object
namestringrequired
expiresnumber
was_onlinenumber
restriction_reasonarray of objects
restriction_reason array
platformstringrequired
reasonstringrequired
textstringrequired
lang_codestring
Twitter variantobject
Twitter variant object
objectstringAccountOwnerProfilerequired
providerstringTWITTERrequired
idstringrequired
namestringrequired
screen_namestringrequired
locationstringrequired
descriptionstringrequired
urlstringrequired
entitiesobjectrequired
entities object
descriptionobjectrequired
description object
urlsarrayrequired
protectedbooleanrequired
verifiedbooleanrequired
followers_countnumberrequired
friends_countnumberrequired
listed_countnumberrequired
favourites_countnumberrequired
statuses_countnumberrequired
created_atstringrequired
profile_banner_urlstring
profile_image_url_httpsstringrequired
default_profilebooleanrequired
default_profile_imagebooleanrequired
withheld_in_countriesarray of stringsrequired
followed_byboolean
followingboolean
follow_request_sentboolean
has_extended_profileboolean
notificationsboolean
advertiser_account_typestring
business_profile_statestring
require_some_consentboolean
Gmail variantobject
Gmail variant object
objectstringAccountOwnerProfilerequired
providerstringGMAILrequired
emailstringrequired
messages_totalnumber
threads_totalnumber
allowed_scopearray of strings
aliasesarray of objectsrequired
aliases array
emailstringrequired
display_namestring
reply_tostring
signaturestring
is_primaryboolean
is_defaultboolean
verification_statusstring
is_treated_as_aliasstring
Outlook variantobject
Outlook variant object
objectstringAccountOwnerProfilerequired
providerstringOUTLOOKrequired
idstringrequired
emailstringrequired
display_namestringrequired
given_namestringrequired
surnamestringrequired
user_principal_namestringrequired
job_titlestringrequired
mobile_phonestringrequired
preferred_languagestringrequired
IMAP variantobject
IMAP variant object
objectstringAccountOwnerProfilerequired
providerstringIMAPrequired
connection_paramsobjectrequired
connection_params object
imapobjectrequired
imap object
usernamestringrequired
portnumberrequired
hoststringrequired
smtpobjectrequired
smtp object
usernamestringrequired
portnumberrequired
hoststringrequired

Example request

curl --request GET \
  --url 'https://api.postpress.ai/api/v1/users/me?account_id=acc_linkedin_01HXYZ4QK3WJ8FN3M6QH7TZ8GR' \
  --header 'X-API-KEY: pp_live_...' \
  --header 'accept: application/json'

Example response

{
  "object": "AccountOwnerProfile",
  "provider": "LINKEDIN",
  "provider_id": "ACoAACr-1eYBl...",
  "entity_urn": "urn:li:fsd_profile:ACoAACr-1eYBl...",
  "object_urn": "urn:li:person:ACoAACr-1eYBl...",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "profile_picture_url": "https://media.licdn.com/.../profile.jpg",
  "public_profile_url": "https://www.linkedin.com/in/ada-lovelace",
  "public_identifier": "ada-lovelace",
  "headline": "Founder at postpress",
  "location": "San Francisco, CA",
  "email": "ada@postpress.ai",
  "premium": true,
  "open_profile": false,
  "occupation": "Founder at postpress",
  "organizations": [
    { "id": "org_1337", "mailbox_id": "mb_1", "name": "postpress" }
  ],
  "recruiter": { "owner_seat_id": "seat_1", "contract_id": "ct_1" },
  "sales_navigator": null
}

Errors

Every error response follows the same envelope:

titlestringrequired
Short error title.
detailstringoptional
Human-readable explanation.
instancestringoptional
Request identifier for support.
typestringrequired
Error type identifier.
statusnumberrequired
HTTP status code.
401 Unauthorized13 types

Credentials are missing, expired, or otherwise invalid.

  • errors/missing_credentials - Some credentials are necessary to perform the request.
  • errors/multiple_sessions - LinkedIn limits multiple sessions on certain Recruiter accounts. Use the cookie connection method.
  • errors/invalid_checkpoint_solution - The checkpoint resolution did not pass successfully. Retry.
  • errors/invalid_proxy_credentials - The provided proxy credentials are invalid.
  • errors/checkpoint_error - The checkpoint does not appear to be resolvable.
  • errors/invalid_credentials - The provided credentials are invalid.
  • errors/expired_credentials - Credentials have expired. Reconnect the account.
  • errors/insufficient_privileges - This resource is out of your API-key scopes.
  • errors/disconnected_account - The account is disconnected from the provider service.
  • errors/disconnected_feature - The service you're trying to reach is disconnected.
  • errors/invalid_credentials_but_valid_account_imap - IMAP/SMTP credentials are invalid but the account is otherwise valid.
  • errors/expired_link - This link has expired. Generate a new one.
  • errors/wrong_account - The provided credentials do not match the correct account.
403 Forbidden9 types

Authenticated but the account is restricted or the action is not allowed.

  • errors/account_restricted - The account has been restricted by the provider.
  • errors/account_mismatch - This action cannot be done with your account.
  • errors/insufficient_permissions - Valid authentication but insufficient permissions to perform the request.
  • errors/session_mismatch - Token user id does not match client session id.
  • errors/feature_not_subscribed - The requested feature has not been subscribed or authenticated properly.
  • errors/subscription_required - A subscription is required to use this feature.
  • errors/unknown_authentication_context - An additional step seems necessary to complete login.
  • errors/action_required - An additional step is required.
  • errors/resource_access_restricted - You don't have access to this resource.
404 Not Found2 types

The account or the owning user could not be found.

  • errors/resource_not_found - The requested resource was not found.
  • errors/invalid_resource_identifier - The provided identifier is not valid.
422 Unprocessable Entity3 types

The account is not designed for this feature, or another constraint is violated.

  • errors/invalid_account - Provided account is not designed for this feature.
  • errors/unprocessable_entity - The request could not be processed as submitted.
  • errors/account_configuration_error - The account configuration prevents this operation.
429 Too Many Requests1 types

The provider cannot accept any more requests at the moment. Retry later.

  • errors/too_many_requests - Provider rate limit reached. Back off and retry.
500 Internal Server Error3 types

Something went wrong on our side or with the upstream provider.

  • errors/unexpected_error - Something went wrong.
  • errors/provider_error - The provider is experiencing operational problems. Retry later.
  • errors/authentication_intent_error - The current authentication intent was killed after failure.
501 Not Implemented1 types

The requested feature is planned but not yet available.

  • errors/feature_not_implemented - This feature has not been implemented yet.
503 Service Unavailable5 types

postpress is temporarily unable to handle the request.

  • errors/no_client_session - No client session is currently running.
  • errors/no_channel - No channel to client session.
  • errors/no_handler - Handler missing for that request.
  • errors/network_down - Network is down on the server side. Retry shortly.
  • errors/service_unavailable - Service temporarily unavailable. Retry later.
504 Gateway Timeout1 types

The upstream provider did not respond in time.

  • errors/request_timeout - Request timed out. Retry, and contact support if it persists.
Updated May 2026