# nv.retrieveLists

Retrieve your Sales Navigator lead or account lists, with the IDs used to save into them.

> The API Reference is also the SDK and CLI reference. Consecutive code fences marked `tab=HTTP`, `tab=Node`, `tab=Python` and `tab=CLI` are the same call on each surface (a fence marked `tab=HTTP,CLI` is the same text for both), and a block between `:::surface <names>` and `:::` applies only to the surfaces it names. Identifiers in the text are written as in Node and in HTTP JSON (camelCase); the Python SDK spells methods, parameters and result attributes in snake_case (`sendMessage` → `send_message`, `reconnectionLink` → `reconnection_link`), while names inside HTTP JSON stay camelCase.

Retrieve the Sales Navigator lead lists or account lists you own. Use a list's `id` as `listId` in [`nv.saveLead`](/docs/action-nv-save-lead) or [`nv.saveAccount`](/docs/action-nv-save-account). To create a list, use [`nv.createList`](/docs/action-nv-create-list); to rename one, use [`nv.renameList`](/docs/action-nv-rename-list); to delete one, use [`nv.deleteList`](/docs/action-nv-delete-list). To read the leads or accounts in a list, use [`nv.retrieveListLeads`](/docs/action-nv-retrieve-list-leads) or [`nv.retrieveListAccounts`](/docs/action-nv-retrieve-list-accounts).

An active Sales Navigator subscription is required.

:::surface node,python
In the SDK this is the `nvRetrieveLists` method. It takes the parameters below except `label`, which exists only in workflow JSON. The result below is returned in `data`.
:::

:::surface cli
The command is `linkedin navigator lists`. Its flag is listed below.
:::

## Constraints

> ⏺️ **Root Start:** allowed.

> ⬆️ **Parent Actions:** N/A.

> ⬇️ **Child Actions:** N/A.

## Parameters

```json tab=HTTP
{
  "actionType": "nv.retrieveLists",
  "label": "leadLists",
  "type": "lead"
}
```

```typescript tab=Node
const workflow = await linkedapi.nvRetrieveLists.execute({
  type: "lead"
});

const { data, errors } = await linkedapi.nvRetrieveLists.result(workflow.workflowId);
```

```python tab=Python
from linkedapi import NvRetrieveListsParams

workflow = linkedapi.nv_retrieve_lists.execute(
    NvRetrieveListsParams(
        type="lead",
    )
)

result = linkedapi.nv_retrieve_lists.result(workflow.workflow_id)
```

```bash tab=CLI
linkedin navigator lists --type lead --json
```

In AI assistants, the MCP tool is `nv_retrieve_lists`. The n8n action is **Retrieve lists in Sales Navigator**; the Make module is **Retrieve Lists in Sales Navigator**.

| Parameter | Description |
| --- | --- |
| `label` | Optional label included in workflow completion. |
| `type` | Required. `lead` for lead lists or `account` for account lists. |

:::surface cli
| Flag | Description |
| --- | --- |
| `--type` | Required. `lead` or `account`. |
:::

## Result options

```json
{
  "actionType": "nv.retrieveLists",
  "label": "leadLists",
  "success": true,
  "data": [
    {
      "id": "7420000000000000001",
      "name": "Q4 outreach",
      "type": "lead",
      "source": "MANUAL",
      "entityCount": 12,
      "url": "https://www.linkedin.com/sales/lists/people/7420000000000000001"
    },
    {
      "id": "7420000000000000002",
      "name": "Recommended Leads",
      "type": "lead",
      "source": "RECOMMENDATION",
      "entityCount": null,
      "url": "https://www.linkedin.com/sales/lists/people/7420000000000000002"
    }
  ]
}
```

| Field | Meaning |
| --- | --- |
| `id` | List ID, as a string. Pass it as `listId` to save into this list. |
| `name` | List name as shown in Sales Navigator. |
| `type` | `lead` or `account`, matching the requested `type`. |
| `source` | Sales Navigator's own list source code: `MANUAL` for lists you created, in Sales Navigator or with [`nv.createList`](/docs/action-nv-create-list); system lists carry other codes, such as `RECOMMENDATION` or `BOOK_OF_BUSINESS` ("My Current Accounts"). This is an open set. |
| `entityCount` | Number of leads or accounts in the list, or `null` when Sales Navigator does not report it. |
| `url` | Opens the list in Sales Navigator. |

List IDs are long numeric strings, often 19 digits – beyond what a JavaScript number holds exactly. Keep them as strings; converting one to a number can change it.

The result includes every list of the requested type that you own, including Sales Navigator's system lists. Not every list can be a save target:

| Subject | Lists you can save to |
| --- | --- |
| Leads, with [`nv.saveLead`](/docs/action-nv-save-lead) | Your custom lead lists (`source` is `MANUAL`). |
| Accounts, with [`nv.saveAccount`](/docs/action-nv-save-account) | Your custom account lists (`source` is `MANUAL`) and "My Current Accounts" (`source` is `BOOK_OF_BUSINESS`). |

Saving to any other list returns `listNotFound`.

Sales Navigator's system lists, such as Recommended Leads and My Current Accounts, cannot be deleted or renamed: [`nv.deleteList`](/docs/action-nv-delete-list) returns `listNotDeletable` and [`nv.renameList`](/docs/action-nv-rename-list) returns `listNotRenamable` for them.

## Error result

An unsuccessful action returns `success: false` with an `error` object. Possible `error.type` values:

- `noSalesNavigator` — the account does not have an active Sales Navigator subscription.
- `unexpectedError` — the lists could not be retrieved or parsed.