--- title: "List all messages" method: GET path: "/api/v1/messages" tags: ["Messaging"] --- # List all messages `GET /api/v1/messages` Returns a list of messages. Some optional parameters are available to filter the results. ## Query parameters - `cursor` string — A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. - `before` string — A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). - `after` string — A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). - `limit` integer — A limit for the number of items returned in the response. The value can be set between 1 and 250. - `sender_id` string - `account_id` string ## Response `200` OK. Request succeeded. - object - `object` 'MessageList', required - `items` object[], required - `object` 'Message', required - `message_id` string — A unique identifier. - `provider_id` string, required - `sender_id` string, required - `text` union, required - string - unknown - `attachments` union[], required - union - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'img', required - `size` object, required - `width` number, required - `height` number, required - `sticker` boolean, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'video', required - `size` object, required - `width` number, required - `height` number, required - `gif` boolean, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'audio', required - `duration` number - `voice_note` boolean, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'file', required - `file_name` string, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'linkedin_post', required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'video_meeting', required - `starts_at` union, required - number - unknown - `expires_at` union, required - number - unknown - `time_range` union, required - number - unknown - `id` string, required — A unique identifier. - `account_id` string, required — A unique identifier. - `chat_id` string, required — A unique identifier. - `chat_provider_id` string, required - `timestamp` string, required - `is_sender` union, required - 0 - 1 - `quoted` object - `message_id` string — A unique identifier. - `provider_id` string, required - `sender_id` string, required - `text` union, required - string - unknown - `attachments` union[], required - union - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'img', required - `size` object, required - … - `sticker` boolean, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'video', required - `size` object, required - … - `gif` boolean, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'audio', required - `duration` number - `voice_note` boolean, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'file', required - `file_name` string, required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'linkedin_post', required - object - `id` string, required - `file_size` number - `unavailable` boolean, required - `mimetype` string - `url` string - `url_expires_at` number - `type` 'video_meeting', required - `starts_at` union, required - … - `expires_at` union, required - … - `time_range` union, required - … - `is_forwarded` boolean - `reactions` object[], required - `value` string, required - `sender_id` string, required - `is_sender` boolean, required - `mentions` object - `seen` union, required - 0 - 1 - `seen_by` object, required - `hidden` union, required - 0 - 1 - `deleted` union, required - 0 - 1 - `edited` union, required - 0 - 1 - `is_event` union, required - 0 - 1 - `delivered` union, required - 0 - 1 - `behavior` union, required - 0 - unknown - `event_type` union - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - `original` string, required - `replies` number - `reply_by` string[] - `parent` string — A unique identifier. - `sender_attendee_id` string, required — A unique identifier. - `subject` union - string - unknown - `message_type` union - 'MESSAGE' - 'INVITATION' - 'INMAIL' - 'INMAIL_DECLINE' - 'INMAIL_REPLY' - 'INMAIL_ACCEPT' - 'STORY_MENTION' - 'STORY_REPLY' - 'CONTACT' - `attendee_type` union - 'MEMBER' - 'ORGANIZATION' - 'OTHER' - `attendee_distance` union - 1 - 2 - 3 - 4 - -1 - `sender_urn` string - `reply_to` object - `id` string, required — A unique identifier. - `provider_id` string, required - `timestamp` string, required - `sender_attendee_id` string, required — A unique identifier. - `sender_id` string, required - `text` union, required - string - unknown - `cursor` union, required - unknown - unknown ## Other responses - `401` — ## Unauthorized ### Missing credentials - Type: "errors/missing_credentials" Some credentials are necessary to perform the request. ### Multiple sessions - Type: "errors/multiple_sessions" LinkedIn limits the use of multiple sessions on certain Recruiter accounts. This error restricts access to this route only, but causing a popup to appear in the user's browser, prompting them to choose a session, which can disconnect the current account. To avoid this error, use the cookie connection method. ### Wrong account - Type: "errors/wrong_account" The provided credentials do not match the correct account. ### Invalid credentials - Type: "errors/invalid_credentials" The provided credentials are invalid. ### Invalid proxy credentials - Type: "errors/invalid_proxy_credentials" The provided proxy credentials are invalid. ### Invalid IMAP configuration - Type: "errors/invalid_imap_configuration" The provided IMAP configuration is invalid. ### Invalid SMTP configuration - Type: "errors/invalid_smtp_configuration" The provided SMTP configuration is invalid. ### Invalid checkpoint solution - Type: "errors/invalid_checkpoint_solution" The checkpoint resolution did not pass successfully. Please retry. ### Checkpoint error - Type: "errors/checkpoint_error" The checkpoint does not appear to be resolvable. Please try again and contact support if the problem persists. ### Expired credentials - Type: "errors/expired_credentials" Invalid credentials. Please check your username and password and try again. ### Expired link - Type: "errors/expired_link" This link has expired. Please return to the application and generate a new one. ### Insufficient privileges - Type: "errors/insufficient_privileges" This resource seems to be out of your scopes. ### Disconnected account - Type: "errors/disconnected_account" The account appears to be disconnected from the provider service. ### Disconnected feature - Type: "errors/disconnected_feature" The service you're trying to reach appears to be disconnected. - `403` — ## Forbidden ### Insufficient permissions - Type: "errors/insufficient_permissions" Valid authentication but insufficient permissions to perform the request. ### Account restricted - Type: "errors/account_restricted" Access to this account has been restricted by the provider. ### Account mismatch - Type: "errors/account_mismatch" This action cannot be done with your account. ### Unknown authentication context - Type: "errors/unknown_authentication_context" An additional step seems necessary to complete login. Please connect to provider with your browser to find out more, then retry authentication. ### Session mismatch - Type: "errors/session_mismatch" Token User id does not match client session id. ### Feature not subscribed - Type: "errors/feature_not_subscribed" The requested feature has either not been subscribed or not been authenticated properly. ### Subscription required - Type: "errors/subscription_required" The action you're trying to achieve requires a subscription to provider's services. ### Resource access restricted - Type: "errors/resource_access_restricted" You don't have access to this resource. ### Action required - Type: "errors/action_required" An additional step seems necessary. Complete authentication on the provider's native application and try again. - `404` — ## Not Found ### Resource not found. The requested resource were not found. Account or sender not found - `500` — ## Internal Server Error ### Unexpected error - Type: "errors/unexpected_error" Something went wrong. {{moreDetails}} ### Provider error - Type: "errors/provider_error" The provider is experiencing operational problems. Please try again later. ### Authentication intent error - Type: "errors/authentication_intent_error" The current authentication intent was killed after failure. Please start the process again from the beginning. - `503` — ## Service Unavailable ### No client session - Type: "errors/no_client_session" No client session is currently running. ### No channel - Type: "errors/no_channel" No channel to client session. ### Handler missing - Type: "errors/no_handler" Handler missing for that request. ### Network down - Type: "errors/network_down" Network is down on server side. Please wait a moment and retry. ### Service unavailable - Type: "errors/service_unavailable" Please try again later. - `504` — ## Gateway Timeout ### Request timed out - Type: "errors/request_timeout" Request Timeout. Please try again, and if the issue persists, contact support. --- [API](https://skmtc.net/unipile/apis/unipile-api-reference.md) · [All operations](https://skmtc.net/unipile/apis/unipile-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unipile/unipile-api-reference/versions/3483a34061f6/schema)