---
title: "Get all List Entries on a List"
method: GET
path: "/v2/lists/{listId}/list-entries"
tags: ["Lists"]
---

# Get all List Entries on a List

`GET /v2/lists/{listId}/list-entries`

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

## Path parameters

- `listId` integer, required

## Query parameters

- `cursor` string
- `limit` integer
- `fieldIds` string[]
- `fieldTypes` string[]

## Response `200`

OK

- ListEntryWithEntityPaged — ListEntryWithEntityPaged model
  - `data` ListEntryWithEntity[], nullable, required — A page of ListEntryWithEntity results
    - union
      - CompanyListEntry
        - `id` integer, required — The list entry's unique identifier
        - `type` 'company', required — The entity type for this list entry
        - `listId` integer, required — The ID of the list that this list entry belongs to
        - `createdAt` string, date-time, required — The date that the list entry was created
        - `creatorId` integer, nullable, required — The ID of the user that created this list entry
        - `entity` Company, required — Company model
          - `id` integer, required — The company's unique identifier
          - `name` string, required — The company's name
          - `domain` string, hostname, nullable, required — The company's primary domain
          - `domains` string[], required — All of the company's domains
          - `isGlobal` boolean, required — Whether or not the company is tenant specific
          - `fields` Field[] — The fields associated with the company
            - `id` string, required — The field's unique identifier
            - `name` string, required — The field's name
            - `type` 'enriched' | 'global' | 'list' | 'relationship-intelligence' | 'hidden', required — The field's category. `hidden` is a redaction state rather than a category: it signals a field on a restricted opportunity the caller cannot manage, whose value is masked.
            - `enrichmentSource` 'affinity-data' | 'dealroom' | 'eventbrite' | 'mailchimp' | 'null', nullable, required — The source of the data in this Field (if it is enriched)
            - `value` union, required
              - …
      - OpportunityListEntry
        - `id` integer, required — The list entry's unique identifier
        - `type` 'opportunity', required — The entity type for this list entry
        - `listId` integer, required — The ID of the list that this list entry belongs to
        - `createdAt` string, date-time, required — The date that the list entry was created
        - `creatorId` integer, nullable, required — The ID of the user that created this list entry
        - `entity` OpportunityWithFields, required — Opportunity model including the opportunity's fields.
          - `id` integer, required — The unique identifier for the opportunity
          - `name` string, required — The name of the opportunity.
          - `listId` integer, required — The ID of the list that the opportunity belongs to
          - `fields` Field[] — The fields associated with the opportunity. Empty for a redacted opportunity.
            - `id` string, required — The field's unique identifier
            - `name` string, required — The field's name
            - `type` 'enriched' | 'global' | 'list' | 'relationship-intelligence' | 'hidden', required — The field's category. `hidden` is a redaction state rather than a category: it signals a field on a restricted opportunity the caller cannot manage, whose value is masked.
            - `enrichmentSource` 'affinity-data' | 'dealroom' | 'eventbrite' | 'mailchimp' | 'null', nullable, required — The source of the data in this Field (if it is enriched)
            - `value` union, required
              - …
          - `isRestricted` boolean, required — Whether the opportunity is restricted. `false` for customers without the Restricted Opportunities feature enabled.
          - `isRedacted` boolean, required — Whether the response is redacted because the requesting user does not have access to sensitive details of this restricted opportunity. When `true`, `fields` is empty. Always `false` when `isRestricted` is `false`.
      - PersonListEntry
        - `id` integer, required — The list entry's unique identifier
        - `type` 'person', required — The entity type for this list entry
        - `listId` integer, required — The ID of the list that this list entry belongs to
        - `createdAt` string, date-time, required — The date that the list entry was created
        - `creatorId` integer, nullable, required — The ID of the user that created this list entry
        - `entity` Person, required — Person model
          - `id` integer, required — The persons's unique identifier
          - `firstName` string, required — The person's first name
          - `lastName` string, nullable, required — The person's last name
          - `primaryEmailAddress` string, email, nullable, required — The person's primary email address
          - `emailAddresses` string[], required — All of the person's email addresses
          - `type` 'internal' | 'external', required — The person's type. `internal` - people who are users within your Affinity instance. `external` - people who are not internal.
          - `fields` Field[] — The fields associated with the person
            - `id` string, required — The field's unique identifier
            - `name` string, required — The field's name
            - `type` 'enriched' | 'global' | 'list' | 'relationship-intelligence' | 'hidden', required — The field's category. `hidden` is a redaction state rather than a category: it signals a field on a restricted opportunity the caller cannot manage, whose value is masked.
            - `enrichmentSource` 'affinity-data' | 'dealroom' | 'eventbrite' | 'mailchimp' | 'null', nullable, required — The source of the data in this Field (if it is enriched)
            - `value` union, required
              - …
  - `pagination` Pagination, required
    - `prevUrl` string, uri, nullable — URL for the previous page
    - `nextUrl` string, uri, nullable — URL for the next page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `default` — Errors

---

[API](https://skmtc.net/affinity/apis/affinity-api-v2.md) · [All operations](https://skmtc.net/affinity/apis/affinity-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinity/affinity-api-v2/revisions/4c2891c31b7f/schema)