--- title: "List all chats" method: GET path: "/api/v1/chats" tags: ["Messaging"] --- # List all chats `GET /api/v1/chats` Returns a list of chats. Some optional parameters are available to filter the results. ## Query parameters - `unread` boolean - `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. - `account_type` 'WHATSAPP' | 'LINKEDIN' | 'SLACK' | 'TWITTER' | 'MESSENGER' | 'INSTAGRAM' | 'TELEGRAM' - `account_id` string — An Unipile account id or a list of Unipile account ids separated by commas. ## Response `200` OK. Request succeeded. - object - `object` 'ChatList', required - `items` object[], required - `object` 'Chat', required - `id` string, required — A unique identifier. - `account_id` string, required — A unique identifier. - `account_type` union, required - 'WHATSAPP' - 'LINKEDIN' - 'SLACK' - 'TWITTER' - 'MESSENGER' - 'INSTAGRAM' - 'TELEGRAM' - `provider_id` string, required - `attendee_provider_id` string - `name` union, required - string - unknown - `type` union, required - 0 - 1 - 2 - `timestamp` union, required - string - unknown - `unread_count` number, required - `archived` union, required - 0 - 1 - `muted_until` union, required - -1 - string - unknown - `read_only` union, required - 0 - 1 - 2 - `disabledFeatures` union[] - union - 'reactions' - 'reply' - `subject` string - `organization_id` string — Linkedin specific ID for organization mailboxes. - `mailbox_id` string — Linkedin specific ID for organization mailboxes. - `content_type` union - 'inmail' - 'sponsored' - 'linkedin_offer' - `folder` union[] - union - 'INBOX' - 'INBOX_LINKEDIN_CLASSIC' - 'INBOX_LINKEDIN_RECRUITER' - 'INBOX_LINKEDIN_SALES_NAVIGATOR' - 'INBOX_LINKEDIN_ORGANIZATION' - 'INBOX_INSTAGRAM_GENERAL' - 'PENDING' - 'OTHER' - 'SPAM' - 'ARCHIVED' - 'HIDDEN' - 'UNKNOWN' - string - `pinned` union, required - 0 - 1 - `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. - `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)