API Reference/Users/List all invitations received

List all invitations received

GEThttps://api.postpress.ai/v1/users/invite/received

Returns a list of all invitations that have been received by the connected account.

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.
limitintegeroptional
Maximum number of items to return. Between 1 and 100. Defaults to 10.
account_idstringrequired
The id of the linked account to perform the request from.

Response 200 OK

objectstringInvitationListrequired
itemsarray of objectsrequired
Invitations received by the account.
items array
objectstringInvitationReceivedrequired
idstringlength ≥ 1required
A unique identifier.
invited_userstringrequired
invited_user_idstringrequired
invited_user_public_idstringrequired
invited_user_descriptionstringrequired
datestringrequired
Raw provider-formatted date.
parsed_datetimestringrequired
ISO 8601 datetime when available.
invitation_textstringrequired
Note attached to the invitation.
inviterobject
inviter object
inviter_namestringrequired
inviter_idstringrequired
inviter_public_identifierstringrequired
inviter_descriptionstringrequired
specificsobject
specifics object
providerstringLINKEDINrequired
shared_secretstringrequired
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/invite/received?limit=10&account_id=acc_linkedin_01HXYZ4QK3WJ8FN3M6QH7TZ8GR' \
  --header 'X-API-KEY: pp_live_...' \
  --header 'accept: application/json'

Example response

{
  "object": "InvitationList",
  "items": [
    {
      "object": "InvitationReceived",
      "id": "inv_01HXYZ4QK3WJ8FN3M6QH7TZ8GR",
      "invited_user": "Ada Lovelace",
      "invited_user_id": "ACoAACr-1eYBl...",
      "invited_user_public_id": "ada-lovelace",
      "invited_user_description": "Founder at postpress",
      "date": "May 12, 2026",
      "parsed_datetime": "2026-05-12T08:14:00.000Z",
      "invitation_text": "Hi, would love to connect.",
      "inviter": {
        "inviter_name": "Jordan Walke",
        "inviter_id": "ACoAABxyz...",
        "inviter_public_identifier": "jordan-walke",
        "inviter_description": "Engineer at Acme"
      },
      "specifics": {
        "provider": "LINKEDIN",
        "shared_secret": "AQH..."
      }
    }
  ],
  "cursor": "eyJvIjoxMH0"
}

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