Skip to main content
GET
/
v2
/
persons
/
fields
Get metadata on Person Fields
curl --request GET \
  --url https://api.affinity.co/v2/persons/fields \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "affinity-data-current-job-title",
      "name": "Current Job Title",
      "type": "enriched",
      "valueType": "filterable-text",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-industry",
      "name": "Industry",
      "type": "enriched",
      "valueType": "filterable-text-multi",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "affinity-data-location",
      "name": "Location",
      "type": "enriched",
      "valueType": "location",
      "enrichmentSource": "affinity-data",
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "field-1",
      "name": "Custom global field",
      "type": "global",
      "valueType": "text",
      "enrichmentSource": null,
      "createdAt": "2024-03-07T20:21:42Z"
    },
    {
      "id": "last-email",
      "name": "Last Email",
      "type": "relationship-intelligence",
      "valueType": "interaction",
      "enrichmentSource": null,
      "createdAt": null
    },
    {
      "id": "source-of-introduction",
      "name": "Source of Introduction",
      "type": "relationship-intelligence",
      "valueType": "person",
      "enrichmentSource": null,
      "createdAt": "2024-03-07T20:21:42Z"
    }
  ],
  "pagination": {
    "prevUrl": null,
    "nextUrl": "https://api.affinity.co/v2/persons/fields?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

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

​
limit
integer<int32>
default:100

Number of items to include in the page

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

100

​
filter
string

Filter options

​
includes
enum<string>[]

Additional properties to include in the response

Available options:
filterability,
sortability

Response

OK

FieldMetadataPaged model

​
data
FieldMetadata · object[]
required

A page of FieldMetadata results

Maximum array length: 100
​
pagination
Pagination · object
required