WarmablyWarmablyDOCS
Search docs⌘K
Dashboard
API Reference/Endpoints

Retrieve a chat

GET/api/linkedin/gateway/chats/{chat_id}

Reads one conversation's current state — its unread count, mute/pin/archive flags, and a preview of its last message.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.

Path parameters

FieldTypeDescription
chat_id *stringThe chat to retrieve.

Query parameters

FieldTypeDescription
account_id *stringThe account this chat belongs to. Must belong to this key.

Response fields

FieldTypeDescription
account_typestringThe connected channel this chat lives on.
namestring | nullThe conversation or group name, when it has one.
unread_countnumberHow many messages in this chat are unread.
archived0 | 1Whether the chat is archived.
muted_untilstring | -1 | nullA timestamp, -1 for muted indefinitely, or null if unmuted.
pinned0 | 1Whether the chat is pinned to the top of the inbox.
read_only0 | 1 | 2Whether replying in this chat is currently allowed.
lastMessageobject | nullA preview of the most recent message, or null for an empty chat.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. account_id doesn't belong to this key.·404 Not Found. No chat with that id exists for this account.
CredentialsRequired
AuthorizationBearer wm_live_••••••••
RequestTry it
curl "https://api.warmably.com/api/linkedin/gateway/chats/9c5e2a71-4b3f-4e8a-9c2d-9f1e6a2b7c44?account_id=459993d2-b0e7-4b19-baf9-45252ca324cf" \
  -H "Authorization: Bearer wm_live_..."
Response
200 OK
{
  "object": "Chat",
  "id": "9c5e2a71-4b3f-4e8a-9c2d-9f1e6a2b7c44",
  "account_id": "459993d2-b0e7-4b19-baf9-45252ca324cf",
  "account_type": "LINKEDIN",
  "name": null,
  "type": 0,
  "unread_count": 0,
  "archived": 0,
  "pinned": 0,
  "read_only": 0,
  "lastMessage": {
    "id": "6e2f1a9c-8b3d-4c2a-9f1e-2b7c449c5e2a",
    "text": "Sounds good, talk soon."
  }
}
No key yet? Create one from Dashboard → API Keys.