Get field values on a single Person
Changed on| ⚠️ This endpoint is currently in BETA |
|---|
Paginate through field values on a single person.
Enriched, global, and relationship-intelligence fields will be included by default. The ids and types parameters can be used to filter the collection. These parameters are mutually exclusive.
List fields are not returned by this endpoint. To retrieve or update list field values, use the list entry fields endpoints.
Request
- Base URLhttps://api.affinity.co
- URLhttps://api.affinity.co/v2/persons/{personId}/fields
- AuthHTTP bearer
Path parameters
Person ID
Query parameters
Field IDs for which to return field data
[ "field-1" ]
Field Types for which to return field data
Cursor for the next or previous page
Number of items to include in the page
Response
OK
Example response
{
"data": [
{
"id": "affinity-data-location",
"name": "Location",
"type": "enriched",
"enrichmentSource": "affinity-data",
"value": {
"type": "company-multi",
"data": [
{
"id": 1,
"name": "Horizon Technologies",
"domain": "horizontech.com"
},
{
"id": 2,
"name": "Crestwood Capital",
"domain": "crestwoodcap.com"
}
]
}
}
],
"pagination": {
"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}Changes
- info
added
authenticationauthorizationbad-requestconflictmethod-not-allowednot-acceptablenot-foundnot-implementedrate-limitservertimeoutunprocessable-entityunsupported-media-typevalidationdiscriminator mapping keys to the/response property for the response status - info
added
bad-requestvalidationdiscriminator mapping keys to the/response property for the response status - info
added
chat-messageemailmeetingcalldiscriminator mapping keys to the/////response property for the response status - info
added
companycompany-multidatetimedropdowndropdown-multinumbernumber-multifilterable-textfilterable-text-multiformula-numberinteractionlocationlocation-multipersonperson-multiranked-dropdowntextdiscriminator mapping keys to the//response property for the response status - info
removed the
hiddenenum value from the//response property for the response status
- info