Persons

Get all Persons

Changed on Nov 3, 2026

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.

get/v2/persons

Request

Base URL
https://api.affinity.co
URL
https://api.affinity.co/v2/persons
Auth
HTTP bearer

Query parameters

cursorstring

Example:ICAgICAgYmVmb3JlOjo6Nw

Cursor for the next or previous page

limitinteger

Example:100

Number of items to include in the page

idsinteger[]

People IDs

fieldIdsstring[]

Field IDs for which to return field data

[
  "field-1"
]

fieldTypesstring[]

Field Types for which to return field data

Response

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"
  }
}

Changes

Nov 3, 2026187749f77548 Revision changes
- info
  added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status
- info
  added bad-request validation discriminator mapping keys to the / response property for the response status
- info
  added chat-message email meeting call discriminator mapping keys to the /////// response property for the response status
- info
  added company company-multi datetime dropdown dropdown-multi number number-multi filterable-text filterable-text-multi formula-number interaction location location-multi person person-multi ranked-dropdown text discriminator mapping keys to the //// response property for the response status
- info
  removed the hidden enum value from the //// response property for the response status

Operation history