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": "<string>",
      "name": "<string>",
      "type": "enriched",
      "enrichmentSource": "affinity-data",
      "valueType": "person"
    }
  ],
  "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

limit
integer<int32>
default:100

Number of items to include in the page

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

100

Response

OK

FieldMetadataPaged model

data
FieldMetadata · object[]
required

A page of FieldMetadata 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"
}