curl --request POST \
  --url https://api.affinity.co/v2/lists/{listId}/list-entries/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "operator": "and",
    "filters": [
      {
        "fieldId": "field-4574182",
        "valueType": "dropdown",
        "operator": "is-any-of",
        "value": [
          {
            "dropdownOptionId": 1
          },
          {
            "dropdownOptionId": 2
          }
        ]
      }
    ]
  }
}
'

{
  "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"
  }
}

Lists

Search List Entries

⚠️ This endpoint is currently in BETA

Search for List Entries on a List matching the given criteria.

Accepts an optional combination of filters, sorts, and a search term. All fields in the request body are optional. Omitting the body entirely is equivalent to GET /v2/lists/{listId}/list-entries with default pagination.

Requires the “Export data from Lists” permission.

Field IDs

Field IDs used in filters, sorts, and search.fieldIds follow the formats described in Working with Field Data. Use GET /v2/lists/{listId}/fields?includes=filterability to discover which fields are filterable and what operators each supports. Use GET /v2/lists/{listId}/fields?includes=sortability for sortable fields.

`attributeId`

Some fields require an attributeId to specify which aspect to filter or sort on. The following relationship intelligence fields all use attributeId: "date-of-activity": last-email, first-email, last-contact, last-event, first-event, next-event.

Use GET /v2/lists/{listId}/fields?includes=filterability to confirm which fields require an attributeId.

Limits

Items per filter group (filters or nested groups): 50
Values per filter (e.g. options in is-any-of): 100
Sort criteria: 5
Search term minimum length: 3 characters
Results per page: 100

Pagination

Uses cursor-based pagination.

POST

lists

{listId}

list-entries

curl --request POST \
  --url https://api.affinity.co/v2/lists/{listId}/list-entries/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "operator": "and",
    "filters": [
      {
        "fieldId": "field-4574182",
        "valueType": "dropdown",
        "operator": "is-any-of",
        "value": [
          {
            "dropdownOptionId": 1
          },
          {
            "dropdownOptionId": 2
          }
        ]
      }
    ]
  }
}
'

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

listId

integer<int64>

required

The ID of the List to search

Required range: 1 <= x <= 9007199254740991

Query Parameters

fieldIds

string[]

Specific field IDs for which to return field data on each List Entry. Cannot be used together with fieldTypes — use one or the other. Use GET /v2/lists/{listId}/fields to discover available field IDs.

fieldTypes

enum<string>[]

A category of fields for which to return field data on each List Entry. Cannot be used together with fieldIds — use one or the other.

Available options:

enriched,

global,

list,

relationship-intelligence

cursor

string

Cursor for the next or previous page.

limit

integer<int32>

default:100

Maximum number of List Entries to return per page

Required range: 1 <= x <= 100

totalCount

boolean

default:false

When true, includes the total count of matching List Entries in the pagination response. Adds additional query cost; use only when needed.

Body

application/json

Search criteria for filtering, sorting, and searching. All fields are optional — omitting the body returns all results with default pagination.

filters

FilterGroup · object

A tree of filter conditions to apply. Supports nested AND/OR grouping. Use the relevant fields endpoint for your resource type to discover available fields, their valueType, and supported operators.

Show child attributes

sorts

SearchSort · object[]

One or more sort criteria, applied in order. Supports up to 5 sort items. Use the relevant fields endpoint for your resource type to discover sortable fields.

Required array length: 1 - 5 elements

Show child attributes

SearchTerm · object

An optional keyword to match against field values. Results must satisfy both the search term AND any provided filters (intersection). Only one search object may be provided. When fieldIds is omitted, the term is matched against the entity name, primary domain (companies), primary email address (persons), or opportunity name.

Show child attributes

Response

Created

ListEntryWithEntityPaged model

data

(CompanyListEntry · object | OpportunityListEntry · object | PersonListEntry · object)[] | null

required

A page of ListEntryWithEntity results

Maximum array length: 100

CompanyListEntry
OpportunityListEntry
PersonListEntry

Show child attributes

Example:

{
  "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

Pagination · object

required

Show child attributes

Get all List Entries on a List Get a single List Entry on a List

⌘I