API referenceLinkedin messaging
GET
/api/v1/chats

Newest first, read from LinkedIn as the member's inbox scrolls (pages of 20, up to 10 pages a call). cursor is a time anchor to continue from. unread=true keeps only unread ones of the page read.

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Query Parameters

account_id*string

The LinkedIn account (lg_…) to act as.

Length1 <= length
limit?integer

How many conversations to return. Default 20; a call reads at most 10 pages of 20, so at most 200 come back.

Range1 <= value
Default20
cursor?string

The cursor the previous page answered, passed back unchanged, for the next page. Leave it out for the first page; a null cursor means there is no next page. Opaque: its form differs by route.

unread?string

true (or 1) keeps only the conversations with unread messages among those read for this page, so a page may hold fewer than limit. false, 0 or absent: all of them.

Value in

  • "true"
  • "false"
  • "1"
  • "0"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/chats?account_id=lg_3f9c2a7b1d&limit=50"
{  "object": "ChatList",  "items": [    {      "object": "Chat",      "id": "lgc_Q2xpZW50Q2hhdA",      "account_id": "lg_3f9c2a7b1d",      "provider_id": "urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAexample,2-ZXhhbXBsZQ==)",      "attendees": [        {          "object": "ChatAttendee",          "id": "ACoAAB1a2b3c4d5e6f",          "provider_id": "ACoAAB1a2b3c4d5e6f",          "public_identifier": "jane-doe",          "name": "Jane Doe",          "picture_url": null,          "profile_url": "https://www.linkedin.com/in/jane-doe",          "specifics": {            "occupation": "Head of Sales at Example Corp"          },          "is_self": 0        }      ],      "timestamp": "2026-10-31T09:30:00.000Z",      "unread_count": 1,      "archived": 0,      "last_message": {        "object": "Message",        "id": "lgm_Zm9vYmFyYmF6cXV4",        "message_id": "lgm_Zm9vYmFyYmF6cXV4",        "chat_id": "lgc_Q2xpZW50Q2hhdA",        "text": "Thanks, happy to talk next week.",        "timestamp": "2026-10-31T09:30:00.000Z",        "is_sender": 0,        "is_event": 0,        "sender_attendee_provider_id": "ACoAAB1a2b3c4d5e6f",        "sender_provider_id": "ACoAAB1a2b3c4d5e6f",        "attachments": []      }    }  ],  "cursor": "1761902400000"}