List all relations

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

Returns a paginated list of all the relations (connections) of an account. Implement carefully and respect provider limits and restrictions.

Authorization

X-API-KEYstringrequired

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

Query parameters

cursorstringoptional

Pagination cursor. Pass the `cursor` from the previous response to fetch the next page. Repeat until `cursor` is `null`. Minimum length 1.

filterstringoptional

Filter results by user name.

limitintegeroptional

Maximum number of items to return. Between 1 and 1000. Defaults to 100.

account_idstringrequired

The linked account to get the relations from.

Response 200 OK

objectstringUserRelationsListrequired

itemsarray of objectsrequired

Relations in the current page.

items array

objectstringUserRelationrequired

first_namestringrequired

last_namestringrequired

headlinestringrequired

public_identifierstringrequired

public_profile_urlstringrequired

created_atnumberrequired

Unix timestamp (ms) when the connection was created.

member_idstringrequired

member_urnstringrequired

connection_urnstringrequired

profile_picture_urlstring

cursorstringrequired

Cursor for the next page, or `null` if this is the last page.

Example request

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

Example response

{
  "object": "UserRelationsList",
  "items": [
    {
      "object": "UserRelation",
      "first_name": "Jordan",
      "last_name": "Walke",
      "headline": "Engineer at Acme",
      "public_identifier": "jordan-walke",
      "public_profile_url": "https://www.linkedin.com/in/jordan-walke",
      "created_at": 1747400000000,
      "member_id": "ACoAACr-1eYBl...",
      "member_urn": "urn:li:fsd_profile:ACoAACr-1eYBl...",
      "connection_urn": "urn:li:fsd_connection:(ACoAABxyz...,ACoAACr-1eYBl...)",
      "profile_picture_url": "https://media.licdn.com/.../profile.jpg"
    }
  ],
  "cursor": "eyJvIjoxMDB9"
}

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 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.

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