Affinity API Integration Profile
Information and guides about integrating with Affinity API
Add Affinity Integration to Your ProductGet all List Entries on a List in Affinity API
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.
| Field Name | API Key | Type | |
|---|---|---|---|
| Path Parameters | pathParameters | object | |
| List Id | pathParameters.listId | integer | |
| Query | query | object | |
| Cursor | query.cursor | string | |
| Limit | query.limit | integer |
| Field Name | API Key | Type | Description |
|---|---|---|---|
| Data | data | array of items | A page of ListEntryWithEntity results |
| Created At | item.createdAt | string | |
| Creator Id | item.creatorId | number | |
| Id | item.id | number | |
| Type | item.type | string |