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

# Affinity: V2 Lists List ID List Entries Get

> List the rows on an Affinity list, with the companies, people or opportunities and their field values. Includes SDK V2 examples, schemas, and cost.

List the rows on an Affinity list, with the companies, people or opportunities and their field values.

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

## 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(
  'affinity_v2_lists_list_id_list_entries_get',
  {
    "listId": 123
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute affinity_v2_lists_list_id_list_entries_get --input '{
  "listId": 123
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe affinity_v2_lists_list_id_list_entries_get --json` for the complete live contract.

## Input reference

Paginate through the List Entries (AKA rows) on a given List. Returns basic information and field data, including list-specific field data, on each Company, Person, or Opportunity on the List. List Entries also include metadata about their creation, i.e., when they were added to the List and by whom. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, List Entries will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the "Export data from Lists" See the live schema below for the complete notes.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.listId` | `integer` | Yes | — | List ID Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `payload.cursor` | `string` | No | — | Cursor for the next or previous page |
| `payload.limit` | `integer` | No | `100` | Number of items to include in the page Format: `int32`. Minimum: 1. Maximum: 100. |
| `payload.fieldIds` | `array` | No | — | Field IDs for which to return field data |
| `payload.fieldTypes` | `array` | No | — | Field Types for which to return field data |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Paginate through the List Entries (AKA rows) on a given List. Returns basic information and field data, including list-specific field data, on each Company, Person, or Opportunity on the List. List Entries also include metadata about their creation, i.e., when they were added to the List and by whom. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, List Entries will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`. Requires the \"Export data from Lists\" [permission](/pages/external-api-v2/permissions).",
    "properties": {
      "listId": {
        "type": "integer",
        "description": "List ID",
        "minimum": 1,
        "maximum": 9007199254740991,
        "format": "int64"
      },
      "cursor": {
        "type": "string",
        "description": "Cursor for the next or previous page"
      },
      "limit": {
        "type": "integer",
        "description": "Number of items to include in the page",
        "default": 100,
        "minimum": 1,
        "maximum": 100,
        "format": "int32"
      },
      "fieldIds": {
        "type": "array",
        "description": "Field IDs for which to return field data",
        "items": {
          "type": "string"
        }
      },
      "fieldTypes": {
        "type": "array",
        "description": "Field Types for which to return field data",
        "items": {
          "type": "string",
          "enum": [
            "enriched",
            "global",
            "list",
            "relationship-intelligence"
          ]
        }
      }
    },
    "required": [
      "listId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | — |
| `result.data.data` | `array \| null` | Yes | — | Maximum items: 100. |
| `result.data.data[].id` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.data[].type` | `"company"` | Yes | — | — |
| `result.data.data[].listId` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.data[].createdAt` | `string` | Yes | — | Format: `date-time`. |
| `result.data.data[].creatorId` | `integer \| null` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.data[].entity` | `object` | Yes | — | — |
| `result.data.data[].entity.id` | `integer` | Yes | — | — |
| `result.data.data[].entity.name` | `string` | Yes | — | — |
| `result.data.data[].entity.domain` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.domains` | `array` | Yes | — | — |
| `result.data.data[].entity.isGlobal` | `boolean` | Yes | — | — |
| `result.data.data[].entity.fields` | `array` | No | — | — |
| `result.data.data[].entity.fields[].id` | `string` | Yes | — | — |
| `result.data.data[].entity.fields[].name` | `string` | Yes | — | — |
| `result.data.data[].entity.fields[].type` | `"enriched" \| "global" \| "list" \| "relationship-intelligence" \| "hidden"` | Yes | — | — |
| `result.data.data[].entity.fields[].enrichmentSource` | `"affinity-data" \| "dealroom" \| "eventbrite" \| "mailchimp" \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value` | `object` | Yes | — | — |
| `result.data.data[].entity.fields[].value.type` | `"company-multi"` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data` | `array \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].id` | `integer` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].name` | `string` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].domain` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.totalCount` | `integer` | No | — | — |
| `result.data.data[].entity.fields[].value.data[].dropdownOptionId` | `integer` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].text` | `string` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].streetAddress` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].city` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].state` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].country` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].continent` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].firstName` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].lastName` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].primaryEmailAddress` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.fields[].value.data[].type` | `"internal" \| "collaborator" \| "external"` | Yes | — | — |
| `result.data.data[].entity.listId` | `integer` | Yes | — | — |
| `result.data.data[].entity.isRestricted` | `boolean` | Yes | — | — |
| `result.data.data[].entity.isRedacted` | `boolean` | Yes | — | — |
| `result.data.data[].entity.firstName` | `string` | Yes | — | — |
| `result.data.data[].entity.lastName` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.primaryEmailAddress` | `string \| null` | Yes | — | — |
| `result.data.data[].entity.emailAddresses` | `array` | Yes | — | — |
| `result.data.data[].entity.type` | `"internal" \| "external"` | Yes | — | — |
| `result.data.pagination` | `object` | Yes | — | — |
| `result.data.pagination.prevUrl` | `string \| null` | No | — | Format: `uri`. |
| `result.data.pagination.nextUrl` | `string \| null` | No | — | Format: `uri`. |
| `result.meta` | `object` | No | — | — |

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe affinity_v2_lists_list_id_list_entries_get --json`.

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

* [Affinity provider guide](https://deepline.com/docs/providers/affinity/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.