Get all Persons
Paginate through Persons in Affinity. Returns basic information and non-list-specific field data on each Person.
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/persons/fields endpoint. When no fieldIds or fieldTypes are provided, Persons 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 All People directory" permission.
Query parameters
Cursor for the next or previous page
Number of items to include in the page
People IDs
Field IDs for which to return field data
[ "field-1" ]
Field Types for which to return field data
Response
OK
Example response
{
"data": [
{
"id": 1,
"firstName": "Jane",
"lastName": "Smith",
"primaryEmailAddress": "jane.smith@northpointvc.com",
"emailAddresses": [
"jane.smith@northpointvc.com"
],
"type": "internal",
"fields": []
},
{
"id": 2,
"firstName": "Michael",
"lastName": "Torres",
"primaryEmailAddress": "m.torres@northpointvc.com",
"emailAddresses": [
"m.torres@northpointvc.com"
],
"type": "external",
"fields": []
}
],
"pagination": {
"prevUrl": "https://api.affinity.co/v2/persons?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/persons?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}