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.
Servers
- https//api.affinity.co
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
listId |
Integer | Yes |
List ID |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | No |
Number of items to include in the page Default value: 100 |
fieldIds[] |
Array | No |
Field IDs for which to return field data |
cursor |
String | No |
Cursor for the next or previous page |
fieldTypes[] |
Array | No |
Field Types for which to return field data |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.