Skip to content

Get Field Value

GET
/fields/{column_id}/values

Read a single custom column value for one contact or company row.

The read-side counterpart of PATCH /fields/{column_id}/values. Resolves column_id to the underlying column_name_db from dynamic_columns (scoped by object_type so a contacts column can’t be read through the companies path), then selects that one value from mashup_contact_attrs (or mashup_company_attrs for companies).

Returns value: null when the column exists but has never been set for that row. Returns 404 when the column or the record does not exist.

Backwards-compat: this is a brand-new route; no existing surface changes. Custom column VALUES are also surfaced inline on the contact/company read endpoints when include_custom_fields=true is passed.

Authorizations

Parameters

Path Parameters

column_id
required

Column ID from g8_list_fields or g8_create_field

integer

Column ID from g8_list_fields or g8_create_field

Query Parameters

record_id
required

Contact ID (entity=‘contacts’) or company ID (entity=‘companies’)

integer

Contact ID (entity=‘contacts’) or company ID (entity=‘companies’)

entity

Target entity: ‘contacts’ or ‘companies’

string
default: contacts

Target entity: ‘contacts’ or ‘companies’

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Response body for reading a single custom column value from one row.

object
column_id
required
integer
entity
required
string
name
required

The underlying column slug (column_name_db).

string
record_id
required
integer
value
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string