Retrieve a profile

GEThttps://api.postpress.ai/v1/users/{identifier}

Retrieve the profile of a user. Implement carefully and respect provider limits and restrictions.

Authorization

X-API-KEYstringrequired

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

Path parameters

identifierstringrequired

The provider's internal id or public id of the requested user (for LinkedIn, the `provider_id` or `public_identifier`).

Query parameters

linkedin_sectionsarray of stringsoptional

LinkedIn-only. Sections to retrieve in detail. Use `*_preview` for all sections in preview, `*` for all sections in full (heavy), or pick individual sections. You can combine selectors, for example `["*_preview", "experience", "skills"]`. If LinkedIn throttles a section, it appears in `throttled_sections` in the response.

linkedin_apistringoptional

LinkedIn-only. Use a non-classic LinkedIn API for the lookup. Requires the corresponding subscription on the linked account.

notifybooleanoptional

LinkedIn-only. Whether the profile visit should be notified to the viewee. Defaults to `false`.

account_idstringrequired

The linked account to perform the request from.

Response 200 OK

The response shape depends on the provider behind the linked account.

LinkedIn profileobject

LinkedIn profile object

objectstringUserProfilerequired

providerstringLINKEDINrequired

provider_idstringrequired

public_identifierstringrequired

public_profile_urlstring

first_namestringrequired

last_namestringrequired

pronounstring

headlinestringrequired

summarystring

locationstring

websitesarray of stringsrequired

profile_picture_urlstring

profile_picture_url_largestring

background_picture_urlstring

hashtagsarray of strings

contact_infoobject

contact_info object

emailsarray of strings

phonesarray of strings

adressesarray of strings

socialsarray of objects

socials object

typestringrequired

namestringrequired

birthdateobject

birthdate object

monthnumberrequired

daynumberrequired

primary_localeobject

primary_locale object

countrystringrequired

languagestringrequired

creator_websiteobject

creator_website object

urlstringrequired

descriptionstringrequired

can_send_inmailboolean

connected_atnumber

is_open_profileboolean

is_premiumboolean

is_influencerboolean

is_creatorboolean

is_hiringboolean

is_open_to_workboolean

is_saved_leadboolean

is_crm_importedboolean

is_relationshipboolean

is_selfboolean

invitationobject

invitation object

typestringrequired

SENTRECEIVED

statusstringrequired

PENDINGIGNOREDWITHDRAWN

work_experiencearray of objects

work_experience object

idstring

positionstringrequired

companystringrequired

company_idstring

company_urlstring

company_picture_urlstring

industryarray of strings

locationstring

descriptionstring

skillsarray of stringsrequired

currentboolean

statusstring

startstringrequired

endstringrequired

work_experience_total_countnumber

volunteering_experiencearray of objects

volunteering_experience object

companystringrequired

descriptionstringrequired

rolestringrequired

causestringrequired

startstringrequired

endstringrequired

volunteering_experience_total_countnumber

educationarray of objects

education object

idstring

schoolstringrequired

school_idstring

school_urlstring

school_picture_urlstring

degreestring

gradestring

field_of_studystring

descriptionstring

activitiesstring

skillsarray of strings

startstringrequired

endstringrequired

education_total_countnumber

skillsarray of objects

skills object

namestringrequired

endorsement_countnumberrequired

endorsement_idnumberrequired

insightsarray of stringsrequired

endorsedbooleanrequired

skills_total_countnumber

languagesarray of objects

languages object

namestringrequired

proficiencystring

languages_total_countnumber

certificationsarray of objects

certifications object

namestringrequired

organizationstringrequired

urlstring

certifications_total_countnumber

projectsarray of objects

projects object

namestringrequired

descriptionstringrequired

skillsarray of stringsrequired

startstringrequired

endstringrequired

projects_total_countnumber

recommendationsobject

recommendations object

receivedarray of objects

received object

textstringrequired

captionstringrequired

actorobjectrequired

actor object

first_namestringrequired

last_namestringrequired

provider_idstringrequired

headlinestringrequired

public_identifierstringrequired

public_profile_urlstringrequired

profile_picture_urlstring

received_total_countnumber

givenarray of objects

given object

textstringrequired

captionstringrequired

actorobjectrequired

actor object

first_namestringrequired

last_namestringrequired

provider_idstringrequired

headlinestringrequired

public_identifierstringrequired

public_profile_urlstringrequired

profile_picture_urlstring

given_total_countnumber

tagsarray of objects

tags object

idstringrequired

namestringrequired

notesarray of objects

notes object

project_idstringrequired

contentstringrequired

created_atnumberrequired

authorobjectrequired

author object

idstringrequired

seat_idstringrequired

first_namestringrequired

last_namestringrequired

public_profile_urlbooleanrequired

candidate_idstring

recruiting_activityarray of objects

Each item is one of the activity variants below.

recruiting_activity array

Messageobject

Message object

eventstringMESSAGErequired

contentstringrequired

statusstringrequired

PENDINGACCEPTEDDECLINEDAWAITING_REPLY

created_atstringrequired

created_byobjectrequired

created_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

updated_atstring

updated_byobject

updated_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

Noteobject

Note object

eventstringrequired

NOTE_ADDEDNOTE_EDITEDNOTE_DELETED

contentstring

created_atstringrequired

created_byobjectrequired

created_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

updated_atstring

updated_byobject

updated_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

Linkobject

Link object

eventstringrequired

LINK_ADDEDLINK_DELETED

contentstringrequired

created_atstringrequired

created_byobjectrequired

created_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

updated_atstring

updated_byobject

updated_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

Candidate statusobject

Candidate status object

eventstringrequired

CANDIDATE_ADDEDCANDIDATE_MOVED

project_idstringrequired

project_namestringrequired

statestringrequired

created_atstringrequired

created_byobjectrequired

created_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

updated_atstring

updated_byobject

updated_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

Profile viewobject

Profile view object

eventstringPROFILE_VIEWrequired

created_atstringrequired

created_byobjectrequired

created_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

updated_atstring

updated_byobject

updated_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

Unhandled eventobject

Unhandled event object

eventstringUNHANDLED_EVENTrequired

created_atstringrequired

created_byobjectrequired

created_by object

provider_idstringrequired

full_namestringrequired

picture_urlstring

throttled_sectionsarray of strings

experienceeducationlanguagesskillscertificationsvolunteering_experienceprojectsrecommendations_receivedrecommendations_given

Sections that returned empty because LinkedIn throttled the request.

follower_countnumber

connections_countnumber

shared_connections_countnumber

network_distancestring

FIRST_DEGREESECOND_DEGREETHIRD_DEGREEOUT_OF_NETWORK

WhatsApp profileobject

WhatsApp profile object

objectstringUserProfilerequired

providerstringWHATSAPPrequired

idstringrequired

is_businessboolean

Instagram profileobject

Instagram profile object

objectstringUserProfilerequired

providerstringINSTAGRAMrequired

provider_idstringrequired

provider_messaging_idstring

public_identifierstringrequired

full_namestringrequired

biographystring

categorystring

profile_picture_urlstring

profile_picture_url_largestring

followers_countnumberrequired

mutual_followers_countnumberrequired

following_countnumberrequired

posts_countnumberrequired

profile_typestringrequired

PERSONNALBUSINESSPROFESSIONNAL

is_verifiedbooleanrequired

is_privatebooleanrequired

external_linksarray of stringsrequired

relationship_statusobjectrequired

relationship_status object

followingbooleanrequired

followed_bybooleanrequired

has_sent_invitationbooleanrequired

has_received_invitationbooleanrequired

businessobject

business object

categorystringrequired

address_streetstringrequired

address_citystringrequired

address_zipcodestringrequired

phone_numberstringrequired

emailstringrequired

Telegram profileobject

Telegram profile object

objectstringUserProfilerequired

providerstringTELEGRAMrequired

provider_idstringrequired

profile_picture_urlstringrequired

selfboolean

contactboolean

mutual_contactboolean

deletedboolean

botboolean

verifiedboolean

restrictedboolean

fakeboolean

premiumboolean

close_friendboolean

first_namestring

last_namestring

usernamestring

phonestring

lang_codestring

statusobject

status object

namestringrequired

expiresnumber

was_onlinenumber

restriction_reasonarray of objects

restriction_reason object

platformstringrequired

reasonstringrequired

textstringrequired

Twitter profileobject

Twitter profile object

objectstringUserProfilerequired

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

Example request

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

Example response

{
  "object": "UserProfile",
  "provider": "LINKEDIN",
  "provider_id": "ACoAACr-1eYBl...",
  "public_identifier": "jordan-walke",
  "public_profile_url": "https://www.linkedin.com/in/jordan-walke",
  "first_name": "Jordan",
  "last_name": "Walke",
  "headline": "Engineer at Acme",
  "summary": "Building things for the web.",
  "location": "San Francisco, California, United States",
  "websites": ["https://jordan.dev"],
  "profile_picture_url": "https://media.licdn.com/.../profile.jpg",
  "profile_picture_url_large": "https://media.licdn.com/.../profile-large.jpg",
  "background_picture_url": "https://media.licdn.com/.../background.jpg",
  "follower_count": 12450,
  "connections_count": 980,
  "shared_connections_count": 23,
  "network_distance": "SECOND_DEGREE",
  "is_premium": true,
  "is_open_to_work": false,
  "is_self": false,
  "work_experience": [
    {
      "position": "Staff Engineer",
      "company": "Acme",
      "company_id": "1234567",
      "company_url": "https://www.linkedin.com/company/acme",
      "industry": ["Software"],
      "location": "Remote",
      "description": "Leading platform team.",
      "skills": ["React", "Node.js"],
      "current": true,
      "start": "2022-04",
      "end": null
    }
  ],
  "work_experience_total_count": 5,
  "education": [
    {
      "school": "MIT",
      "degree": "B.S.",
      "field_of_study": "Computer Science",
      "start": "2010",
      "end": "2014"
    }
  ],
  "education_total_count": 1,
  "skills_total_count": 32,
  "languages": [{ "name": "English", "proficiency": "NATIVE_OR_BILINGUAL" }],
  "languages_total_count": 1,
  "throttled_sections": []
}

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 user could not be found.

errors/resource_not_found - The requested user was not found.
errors/invalid_resource_identifier - The provided identifier is not valid.

422 Unprocessable Entity5 types

The request is well-formed but cannot be fulfilled as-is.

errors/invalid_account - The provided account is not designed for this feature.
errors/user_unreachable - The target user cannot be reached on the provider.
errors/unprocessable_entity - The request cannot be processed in its current form.
errors/account_configuration_error - The account configuration prevents this request.
errors/provider_unreachable - The provider is currently unreachable.

429 Too Many Requests1 types

The provider is rate-limiting this account. Slow down and retry.

errors/too_many_requests - The provider cannot accept any more requests at the moment.

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