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"
}
}{
"errors": [
{
"code": "bad-request",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authorization",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "not-found",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authentication",
"message": "<string>"
}
]
}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.
Search
The search.term is always matched against the entity’s name and primary identifier: company name and primary domain (company lists), person first name, last name, and primary email address (person lists), or opportunity name (opportunity lists). Providing search.fieldIds extends the search to those additional fields; it does not restrict matching to only those fields. Fields with a valueType of datetime are not searchable and are silently ignored if included in search.fieldIds.
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.
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"
}
}{
"errors": [
{
"code": "bad-request",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authorization",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "not-found",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authentication",
"message": "<string>"
}
]
}Authorizations
A static Affinity API key, presented as a bearer token.
Path Parameters
The ID of the List to search
1 <= x <= 9007199254740991Query Parameters
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.
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.
enriched, global, list, relationship-intelligence Cursor for the next or previous page.
Maximum number of List Entries to return per page
1 <= x <= 100When true, includes the total count of matching List Entries in the pagination response. Adds additional query cost; use only when needed.
Body
Search criteria for filtering, sorting, and searching. All fields are optional — omitting the body returns all results with default pagination.
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
Show child attributes
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.
1 - 5 elementsShow child attributes
Show child attributes
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. The term is always matched against the entity name and primary identifier; providing fieldIds extends the search to additional fields rather than replacing the identity match.
Show child attributes
Show child attributes
Response
Created
ListEntryWithEntityPaged model
A page of ListEntryWithEntity results
100- CompanyListEntry
- OpportunityListEntry
- PersonListEntry
Show child attributes
Show child attributes
{
"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": []
}
}
Show child attributes
Show child attributes
Was this page helpful?