API Reference/Messaging/List all attendees from a chat

List all attendees from a chat

GEThttps://api.postpress.ai/v1/chats/{chat_id}/attendees

Return all messaging attendees in a chat, including provider-specific profile data when available.

Authorization

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

Path parameters

chat_idstringrequired
The id of the chat whose attendees should be returned.

Response 200 OK

objectstringChatAttendeeListrequired
itemsarray of objectsrequired
Attendees in the chat.
items array
objectstringChatAttendeerequired
idstringlength ≥ 1required
account_idstringlength ≥ 1required
provider_idstringrequired
namestringrequired
is_selfnumberrequired
01
hiddennumber
01
picture_urlstring
profile_urlstring
specificsobject
Provider-specific extra fields. One of the variants below.
specifics object
LinkedIn variantobject
LinkedIn variant object
providerstringLINKEDINrequired
member_urnstringrequired
occupationstring
network_distancestring
SELFDISTANCE_1DISTANCE_2DISTANCE_3OUT_OF_NETWORK
pending_invitationboolean
locationstring
headlinestring
contact_infoobject
contact_info object
emailsarray of strings
emails array
<email>string
phone_numbersarray of strings
phone_numbers array
<phone_number>string
websitesarray of strings
websites array
<website>string
social_handlesarray of objects
social_handles array
typestringrequired
namestringrequired
Instagram variantobject
Instagram variant object
providerstringINSTAGRAMrequired
public_identifierstringrequired
relationship_statusobjectrequired
relationship_status object
followingboolean
followed_byboolean
has_received_invitationboolean
has_sent_invitationboolean
cursorstringrequired
Always present. `null` since this endpoint returns the full attendee list.

Example request

curl --request GET \
  --url 'https://api.postpress.ai/api/v1/chats/chat_01HXYZ4QK3WJ8FN3M6QH7TZ8GR/attendees' \
  --header 'X-API-KEY: pp_live_...' \
  --header 'accept: application/json'

Example response

{
  "object": "ChatAttendeeList",
  "items": [
    {
      "object": "ChatAttendee",
      "id": "att_01HXYZ4QK3WJ8FN3M6QH7TZ8GR",
      "account_id": "acc_01HXYZ4QK3WJ8FN3M6QH7TZ8GR",
      "provider_id": "ACoAACr-1eYBl...",
      "name": "Jordan Walke",
      "is_self": 0,
      "hidden": 0,
      "picture_url": "https://media.licdn.com/.../profile.jpg",
      "profile_url": "https://www.linkedin.com/in/jordan-walke",
      "specifics": {
        "provider": "LINKEDIN",
        "member_urn": "urn:li:fsd_profile:ACoAACr-1eYBl...",
        "occupation": "Engineer at Acme",
        "network_distance": "DISTANCE_2",
        "pending_invitation": false,
        "location": "San Francisco, CA",
        "headline": "Building developer tools"
      }
    }
  ],
  "cursor": 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 chat id does not match any chat visible to this API key.

  • errors/resource_not_found - The requested resource was not found.
  • errors/invalid_resource_identifier - The provided identifier is not a valid chat id.
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.
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