Skip to main content
GET
Get a single field value on a Company

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

Example:

"affinity-data-location"

name
string
required

The field's name

Example:

"Location"

type
enum<string>
required

The field's category. hidden is a redaction state rather than a category: it signals a field on a restricted opportunity the caller cannot manage, whose value is masked.

Available options:
enriched,
global,
list,
relationship-intelligence,
hidden
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: