Skip to main content
GET
/
v2
/
persons
Get all Persons
curl --request GET \
  --url https://api.affinity.co/v2/persons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 4503599627370496,
      "firstName": "<string>",
      "lastName": "<string>",
      "primaryEmailAddress": "[email protected]",
      "emailAddresses": [
        "[email protected]"
      ],
      "type": "internal",
      "fields": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "enriched",
          "enrichmentSource": "affinity-data",
          "value": {
            "data": {
              "continent": "North America",
              "country": "United States",
              "streetAddress": "1 Main Street",
              "city": "San Francisco",
              "state": "California"
            },
            "type": "location"
          }
        }
      ]
    }
  ],
  "pagination": {
    "prevUrl": "<string>",
    "nextUrl": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
cursor
string

Cursor for the next or previous page

Example:

"ICAgICAgYmVmb3JlOjo6Nw"

​
limit
integer<int32>
default:100

Number of items to include in the page

Required range: 1 <= x <= 100
Example:

100

​
ids
integer<int64>[]

People IDs

Required range: 1 <= x <= 9007199254740991
​
fieldIds
string[]

Field IDs for which to return field data

Example:
["field-1"]
​
fieldTypes
enum<string>[]

Field Types for which to return field data

Available options:
enriched,
global,
relationship-intelligence

Response

OK

PersonPaged model

​
data
Person · object[]
required

A page of Person results

Maximum array length: 100
​
pagination
Pagination · object
required
Example:
{
  "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
  "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}