Skip to main content
GET
/
v2
/
companies
/
{companyId}
/
fields
/
{fieldId}
Get a single field value on a Company
curl --request GET \
  --url https://api.affinity.co/v2/companies/{companyId}/fields/{fieldId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "field-1",
  "name": "Field with company value",
  "type": "global",
  "enrichmentSource": null,
  "value": {
    "type": "company",
    "data": {
      "id": 1,
      "name": "Acme",
      "domain": "acme.co"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.affinity.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
companyId
integer<int64>
required

Company ID

Required range: 1 <= x <= 9007199254740991
​
fieldId
string
required

Field ID

Examples:

"affinity-data-location"

"field-1234"

Response

OK

​
id
string
required

The field's unique identifier

Examples:

"affinity-data-location"

"field-1234"

​
name
string
required

The field's name

Example:

"Location"

​
type
enum<string>
required

The field's type

Available options:
enriched,
global,
list,
relationship-intelligence
Example:

"enriched"

​
enrichmentSource
enum<string> | null
required

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

Available options:
affinity-data,
dealroom,
eventbrite,
mailchimp,
null
Example:

"affinity-data"

​
value
CompaniesValue · object
required
Example:
{
  "data": {
    "continent": "North America",
    "country": "United States",
    "streetAddress": "1 Main Street",
    "city": "San Francisco",
    "state": "California"
  },
  "type": "location"
}