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

# Unipile: List Received Invitations

> List the connection invitations a connected account received. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the connection invitations a connected account received.

> [!NOTE]
>
> Tool ID: `unipile_list_received_invitations`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_list_received_invitations',
  {
    "account_id": "123456789"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_list_received_invitations --input '{
  "account_id": "123456789"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "InvitationList",
    "items": [
      {
        "object": "InvitationReceived",
        "id": "id_123",
        "invited_user": "example",
        "invited_user_id": "invited_user_123",
        "invited_user_public_id": "invited_user_public_123",
        "invited_user_description": "example",
        "date": "2026-01-15T12:00:00Z",
        "parsed_datetime": "2026-01-15T12:00:00Z",
        "invitation_text": "example"
      }
    ],
    "cursor": "cursor_123"
  }
}
```

Use `deepline describe unipile_list_received_invitations --json` for the latest machine-readable contract.

## Input reference

Returns a list of all invitations that have been received.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.cursor` | `string` | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. Minimum length: 1. |
| `payload.limit` | `integer` | No | `10` | A limit for the number of items returned in the response. The value can be set between 1 and 100. Minimum: 1. Maximum: 100. |
| `payload.account_id` | `string` | Yes | — | The id of the account to perform the request from. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a list of all invitations that have been received.",
    "properties": {
      "cursor": {
        "type": "string",
        "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.",
        "minLength": 1
      },
      "limit": {
        "type": "integer",
        "description": "A limit for the number of items returned in the response. The value can be set between 1 and 100.",
        "default": 10,
        "minimum": 1,
        "maximum": 100
      },
      "account_id": {
        "type": "string",
        "description": "The id of the account to perform the request from."
      }
    },
    "required": [
      "account_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"InvitationList"` | Yes | — | Allowed: `InvitationList`. |
| `result.data.items` | `array` | Yes | — | — |
| `result.data.items[].object` | `"InvitationReceived"` | Yes | — | Allowed: `InvitationReceived`. |
| `result.data.items[].id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.items[].invited_user` | `string \| null` | Yes | — | — |
| `result.data.items[].invited_user_id` | `string \| null` | Yes | — | — |
| `result.data.items[].invited_user_public_id` | `string \| null` | Yes | — | — |
| `result.data.items[].invited_user_description` | `string \| null` | Yes | — | — |
| `result.data.items[].date` | `string` | Yes | — | — |
| `result.data.items[].parsed_datetime` | `string \| null` | Yes | — | — |
| `result.data.items[].invitation_text` | `string \| null` | Yes | — | — |
| `result.data.items[].inviter` | `object` | No | — | — |
| `result.data.items[].inviter.inviter_name` | `string` | Yes | — | — |
| `result.data.items[].inviter.inviter_id` | `string` | Yes | — | — |
| `result.data.items[].inviter.inviter_public_identifier` | `string` | Yes | — | — |
| `result.data.items[].inviter.inviter_description` | `string \| null` | Yes | — | — |
| `result.data.items[].specifics` | `object` | No | — | — |
| `result.data.items[].specifics.provider` | `"LINKEDIN"` | Yes | — | Allowed: `LINKEDIN`. |
| `result.data.items[].specifics.shared_secret` | `string` | Yes | — | — |
| `result.data.cursor` | `string \| null` | Yes | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "InvitationList"
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "object": {
                  "type": "string",
                  "enum": [
                    "InvitationReceived"
                  ]
                },
                "id": {
                  "type": "string",
                  "description": "A unique identifier.",
                  "minLength": 1
                },
                "invited_user": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "invited_user_id": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "invited_user_public_id": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "invited_user_description": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "date": {
                  "type": "string"
                },
                "parsed_datetime": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "invitation_text": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "inviter": {
                  "type": "object",
                  "properties": {
                    "inviter_name": {
                      "type": "string"
                    },
                    "inviter_id": {
                      "type": "string"
                    },
                    "inviter_public_identifier": {
                      "type": "string"
                    },
                    "inviter_description": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "inviter_name",
                    "inviter_id",
                    "inviter_public_identifier",
                    "inviter_description"
                  ],
                  "additionalProperties": false
                },
                "specifics": {
                  "type": "object",
                  "properties": {
                    "provider": {
                      "type": "string",
                      "enum": [
                        "LINKEDIN"
                      ]
                    },
                    "shared_secret": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "provider",
                    "shared_secret"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "object",
                "id",
                "invited_user",
                "invited_user_id",
                "invited_user_public_id",
                "invited_user_description",
                "date",
                "parsed_datetime",
                "invitation_text"
              ],
              "additionalProperties": false
            }
          },
          "cursor": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "object",
          "items",
          "cursor"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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