AFaffinity
Lists

Get all List Entries on a List

Changed on

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.

get/v2/lists/{listId}/list-entries

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/lists/{listId}/list-entries
  • Auth
    HTTP bearer

Path parameters

listIdinteger required

List ID

Query parameters

cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw

Cursor for the next or previous page

limitinteger
Example:100

Number of items to include in the page

fieldIdsstring[]

Field IDs for which to return field data

[
  "field-1"
]
fieldTypesstring[]

Field Types for which to return field data

Response

OK

Example response

{
  "data": [
    {
      "id": 1,
      "type": "company",
      "listId": 1,
      "createdAt": "2023-01-01T00:00:00Z",
      "creatorId": 1,
      "entity": {
        "id": 1,
        "name": "Horizon Technologies",
        "domain": "horizontech.com",
        "domains": [
          "horizontech.com"
        ],
        "isGlobal": true,
        "fields": []
      }
    }
  ],
  "pagination": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status

    • info

      added chat-message email meeting call discriminator mapping keys to the ///////// response property for the response status

    • info

      added chat-message email meeting call discriminator mapping keys to the ///////// response property for the response status

    • info

      added chat-message email meeting call discriminator mapping keys to the ///////// response property for the response status

    • info

      added company company-multi datetime dropdown dropdown-multi number number-multi filterable-text filterable-text-multi formula-number interaction location location-multi person person-multi ranked-dropdown text discriminator mapping keys to the ////// response property for the response status

    • info

      added company company-multi datetime dropdown dropdown-multi number number-multi filterable-text filterable-text-multi formula-number interaction location location-multi person person-multi ranked-dropdown text discriminator mapping keys to the ////// response property for the response status

    • info

      added company company-multi datetime dropdown dropdown-multi number number-multi filterable-text filterable-text-multi formula-number interaction location location-multi person person-multi ranked-dropdown text discriminator mapping keys to the ////// response property for the response status

    • info

      added company opportunity person discriminator mapping keys to the / response property for the response status

    • info

      removed the hidden enum value from the ////// response property for the response status

    • info

      removed the hidden enum value from the ////// response property for the response status

    • info

      removed the hidden enum value from the ////// response property for the response status