# Retrieve a chat

- **URL:** https://developer.unipile.com/reference/chatscontroller_getchat
- **Summary:** Retrieve the details of a chat.

chat_id

string

required

The Unipile or provider ID of the chat.

account_id

string

Mandatory if the chat ID is a provider ID.

200

OK. Request succeeded.

===============================

object

id

string

required

length ≥ 1

A unique identifier.

account_id

string

required

length ≥ 1

A unique identifier.

account_typeString 1String 2String 3String 4String 5String 6String 7

enum

required

`WHATSAPP`

provider_id

string

required

attendee_provider_id

string

name

string

required

string

Option 2

typeNumber 1Number 2Number 3

enum

required

`0`

timestamp

string

required

string

Option 2

unread_count

number

required

archivedNumber 1Number 2

enum

required

`0`

muted_until

number | string

required

number

string

Option 3

read_onlyNumber 1Number 2Number 3

enum

required

`0`

disabledFeatures

array

disabledFeatures

String 1String 2

subject

string

organization_id

string

Linkedin specific ID for organization mailboxes.

mailbox_id

string

Linkedin specific ID for organization mailboxes.

content_typeString 1String 2String 3

enum

`inmail`

folder

array

folder

String 1String 2String 3String 4String 5String 6String 7String 8String 9String 10String 11String 12String 13

pinnedNumber 1Number 2

enum

required

`0`

object

string

enum

required

`Chat`

lastMessage

object

required

object

Option 2

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.  
Chat not found
> Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md).
https://api1.unipile.com:13111/api/v1/chats/{chat_id}

1

curl \--request GET \\

2

     \--url https://api1.unipile.com:13111/api/v1/chats/chat_id \\

3

     \--header 'accept: application/json'

243

1

{

2

  "id": "string",

3

  "account_id": "string",

4

  "account_type": "WHATSAPP",

5

  "provider_id": "string",

6

  "attendee_provider_id": "string",

7

  "name": "string",

8

  "type": 0,

9

  "timestamp": "string",

10

  "unread_count": 0,

11

  "archived": 0,

12

  "muted_until": \-1,

13

  "read_only": 0,

14

  "disabledFeatures": \[\
\
15\
\
    "reactions",\
\
16\
\
    "reply"\
\
17\
\
  \],

18

  "subject": "string",

19

  "organization_id": "string",

20

  "mailbox_id": "string",

21

  "content_type": "inmail",

22

  "folder": \[\
\
23\
\
    "INBOX",\
\
24\
\
    "INBOX_LINKEDIN_CLASSIC",\
\
25\
\
    "INBOX_LINKEDIN_RECRUITER",\
\
26\
\
    "INBOX_LINKEDIN_SALES_NAVIGATOR",\
\
27\
\
    "INBOX_LINKEDIN_ORGANIZATION",\
\
28\
\
    "INBOX_INSTAGRAM_GENERAL",\
\
29\
\
    "PENDING",\
\
30\
\
    "OTHER",\
\
31\
\
    "SPAM",\
\
32\
\
    "ARCHIVED",\
\
33\
\
    "HIDDEN",\
\
34\
\
    "UNKNOWN",\
\
35\
\
    "string"\
\
36\
\
  \],

37

  "pinned": 0,

38

  "object": "Chat",

39

  "lastMessage": {

40

    "message_id": "string",

41

    "provider_id": "string",

42

    "sender_id": "string",

43

    "text": "string",

44

    "attachments": \[\
\
\
* * *\
\
\
\
Yes\
\
No
