> ## Documentation Index
> Fetch the complete documentation index at: https://docs.linkupapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Invitations

> Retrieve a paginated list of pending invitations received.

## 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.

> [!NOTE]
>
> This endpoint consumes **1 credit per 50 results** returned. The platform returns up to **100 invitations per internal request**, so larger `count` values trigger multiple upstream calls automatically. Ignore this if you're on per-seat pricing: usage is unlimited.

## 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`

**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`

**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`

**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`

**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.

```json 200 theme={null}
{
  "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"
  }
}
```

```json 400 theme={null}
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "account_id or account_ids is required"
  },
  "metadata": {
    "action": "list_invitations",
    "account_id": null,
    "credits_consumed": 0,
    "timestamp": "2026-04-26T10:35:00Z"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.