List Invitations

curl --request POST \
  --url https://api.linkupapi.com/v2/network \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "action": "<string>",
  "params": {
    "count": 123,
    "offset": 123,
    "invitation_type": "<string>"
  }
}
'

{
  "success": true,
  "data": {
    "invitations": [
      {
        "entity_urn": "urn:li:invitation:123456789",
        "shared_secret": "abcdef12-3456-7890-abcd-ef1234567890",
        "sender": {
          "first_name": "Alice",
          "last_name": "Johnson",
          "headline": "Data Scientist",
          "linkedin_url": "https://www.linkedin.com/in/alicejohnson",
          "profile_picture_url": "https://media.licdn.com/dms/image/..."
        },
        "invitation_type": "CONNECTION",
        "sent_time": "1d",
        "sent_time_days": 1
      }
    ],
    "total_results": 1,
    "total_available_results": 26,
    "pagination": {
      "offset": 0,
      "count": 1,
      "next_offset": 1,
      "has_more": true,
      "results_per_page": 10,
      "pages_fetched": 1
    }
  },
  "metadata": {
    "action": "list_invitations",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

POST

network

List Invitations

curl --request POST \
  --url https://api.linkupapi.com/v2/network \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "action": "<string>",
  "params": {
    "count": 123,
    "offset": 123,
    "invitation_type": "<string>"
  }
}
'

{
  "success": true,
  "data": {
    "invitations": [
      {
        "entity_urn": "urn:li:invitation:123456789",
        "shared_secret": "abcdef12-3456-7890-abcd-ef1234567890",
        "sender": {
          "first_name": "Alice",
          "last_name": "Johnson",
          "headline": "Data Scientist",
          "linkedin_url": "https://www.linkedin.com/in/alicejohnson",
          "profile_picture_url": "https://media.licdn.com/dms/image/..."
        },
        "invitation_type": "CONNECTION",
        "sent_time": "1d",
        "sent_time_days": 1
      }
    ],
    "total_results": 1,
    "total_available_results": 26,
    "pagination": {
      "offset": 0,
      "count": 1,
      "next_offset": 1,
      "has_more": true,
      "results_per_page": 10,
      "pages_fetched": 1
    }
  },
  "metadata": {
    "action": "list_invitations",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

Overview

Returns a paginated list of pending connection invitations received by the account. Pagination is offset-based — set count for the page size and offset to skip ahead.

This endpoint consumes 1 credit per 50 results returned. LinkedIn returns up to 100 invitations per internal request, so larger count values trigger multiple upstream calls automatically.

Request

x-api-key

string

required

Your API key for authentication.

account_id

string

required

The unique identifier of the account to use.

action

string

required

Must be "list_invitations".

params

object

Show params properties

count

integer

default:10

Number of invitations to return. Defaults to 10. Capped at 1000 per call — to retrieve more, paginate with offset.

offset

integer

default:0

Zero-indexed offset into the invitations list. Defaults to 0. Use pagination.next_offset from a previous response to fetch the next page.

invitation_type

string

Filter by invitation type (e.g. "CONNECTION"). Omit for all types.

Response

success

boolean

Indicates whether the request was successful.

data

object

Show data properties

invitations

array

List of invitation objects with entity_urn, shared_secret, sender info, type, and timing.

total_results

integer

Number of invitations returned in this response.

total_available_results

integer

Total number of pending invitations available on the account.

pagination

object

Show pagination properties

offset

integer

Offset of the first invitation in this response.

count

integer

Number of invitations returned (mirrors total_results).

next_offset

integer

Offset to send as offset in the next request. null when there are no more results.

has_more

boolean

true if more invitations are available beyond this batch.

results_per_page

integer

Maximum batch size used per upstream request.

pages_fetched

integer

Number of internal upstream batches consumed to assemble this response.

metadata

object

Show metadata properties

action

string

The action that was performed ("list_invitations").

account_id

string

The account ID used for the request.

credits_consumed

integer

Number of credits consumed (1 per 50 results).

timestamp

string

ISO 8601 timestamp of the response.

{
  "success": true,
  "data": {
    "invitations": [
      {
        "entity_urn": "urn:li:invitation:123456789",
        "shared_secret": "abcdef12-3456-7890-abcd-ef1234567890",
        "sender": {
          "first_name": "Alice",
          "last_name": "Johnson",
          "headline": "Data Scientist",
          "linkedin_url": "https://www.linkedin.com/in/alicejohnson",
          "profile_picture_url": "https://media.licdn.com/dms/image/..."
        },
        "invitation_type": "CONNECTION",
        "sent_time": "1d",
        "sent_time_days": 1
      }
    ],
    "total_results": 1,
    "total_available_results": 26,
    "pagination": {
      "offset": 0,
      "count": 1,
      "next_offset": 1,
      "has_more": true,
      "results_per_page": 10,
      "pages_fetched": 1
    }
  },
  "metadata": {
    "action": "list_invitations",
    "account_id": "your-account-id",
    "credits_consumed": 1,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}

List Connections List Sent Invitations

​Overview

​Request

​Response

Overview

Request

Response