AFaffinity
Persons

Get a single field on a Person

Changed on
⚠️ This endpoint is currently in BETA

Retrieve a single field on a person. Returns basic information and the field value.

get/v2/persons/{personId}/fields/{fieldId}

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/persons/{personId}/fields/{fieldId}
  • Auth
    HTTP bearer

Path parameters

personIdinteger required

Person ID

fieldIdstring required
Example:affinity-data-location

Field ID

Response

OK

idstring required

The field's unique identifier

namestring required

The field's name

type'enriched' | 'global' | 'list' | 'relationship-intelligence' required

The field's type

enrichmentSource'affinity-data' | 'dealroom' | 'eventbrite' | 'mailchimp' | 'null' nullable required

The source of the data in this Field (if it is enriched)

Example response

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

Changes

  • 187749f77548Revision 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