Fetch Message Threads

This API retrieves a list of message threads from the authenticated user's LinkedIn inbox.

POST /api/v1/personal_message_threads

This API retrieves a list of message threads from the authenticated user's LinkedIn inbox.

Headers

Name	Type	Required
x-api-key	string	Yes
x-api-secret	string	Yes

Request Body

Schema

accountIdstringrequiredThe unique identifier of the WeLink account.

next_cursorstringPagination cursor for the next page of results.

Sample Request

{
  "accountId": "string",
  "next_cursor": "string"
}

Responses

Webhook Events

Schema

statusstringStatus indicating the request completed successfully (e.g. "SUCCESS").

requestIdstringUnique identifier for the request.

resultobjectThe response payload.

threadsarray[]Array of message threads.

next_cursorstringPagination cursor for the next page of results.

Sample Response

{
  "status": "string",
  "requestId": "string",
  "result": {
    "threads": [
      {
        "thread_id": "string",
        "created_at": 0,
        "last_activity_at": 0,
        "read": false,
        "unread_count": 0,
        "profile_id": "string",
        "first_name": "string",
        "last_name": "string",
        "full_name": "string",
        "degree": "string",
        "image": "string",
        "last_message_body": "string",
        "last_message_at": 0,
        "last_message_id": "string"
      }
    ],
    "next_cursor": "string"
  }
}

POST /api/v1/sales_message_threads

This API retrieves a list of message threads, from authenticated user's LinkedIn Sales Navigator inbox.

Headers

Name	Type	Required
x-api-key	string	Yes
x-api-secret	string	Yes

Request Body

Schema

accountIdstringrequiredThe unique identifier of the WeLink account.

page_starts_atnumberrequiredPagination cursor or start index.

Sample Request

{
  "accountId": "string",
  "page_starts_at": 0
}

Responses

Webhook Events

Schema

statusstringStatus indicating the request completed successfully (e.g. "SUCCESS").

requestIdstringUnique identifier for the request.

resultobjectThe response payload.

threadsarray[]Array of message threads.

Sample Response

{
  "status": "string",
  "requestId": "string",
  "result": {
    "threads": [
      {
        "thread_id": "string",
        "last_activity_at": 0,
        "read": false,
        "unread": 0,
        "total_message_count": 0,
        "sales_profile_id": "string",
        "full_name": "string",
        "first_name": "string",
        "last_name": "string",
        "degree": 0,
        "image": "string",
        "last_message_id": "string",
        "last_message_body": "string"
      }
    ]
  }
}

POST /api/v1/recruiter_message_threads

Retrieves message threads from LinkedIn Recruiter inbox with filtering options.

Filtering options: UNRESOLVED, INBOX, ARCHIVED, SCHEDULED.

Note

LinkedIn doesn't allow two concurrent sessions on a recruiter plan.

contract_id can be obtained by calling the /api/v1/recruiter_contracts endpoint and extracting the contract_id from the response.

seat_id can be obtained by calling the /api/v1/recruiter_me endpoint and extracting the seat_id from the response.

Headers

Name	Type	Required
x-api-key	string	Yes
x-api-secret	string	Yes

Request Body

Schema

contract_idstringrequiredThe contract identifier for Recruiter accounts.

seat_idstringrequiredSeat identifier for recruiter accounts.

pagenumberrequiredThe page number to retrieve (pagination).

filterstringFilter criteria for the search operation. Accepts UNRESOLVED, INBOX, ARCHIVED, SCHEDULED and defaults to INBOX.

Sample Request

{
  "contract_id": "string",
  "seat_id": "string",
  "page": 0,
  "filter": "string"
}

Responses

Webhook Events

Schema

statusstringStatus indicating the request completed successfully (e.g. "SUCCESS").

resultobjectThe response payload.

threadsarray[]Array of message threads.

Sample Response

{
  "status": "string",
  "result": {
    "threads": [
      {
        "thread_id": "string",
        "profile_id": "string",
        "full_name": "string",
        "first_name": "string",
        "last_name": "string",
        "last_activity_at": 0,
        "read": false,
        "request_state": "string",
        "last_message_body": "string",
        "last_message_id": "string",
        "last_message_state": "string"
      }
    ]
  }
}