Skip to content

Get Record Column Values

POST
/contacts/column-values

Every column value for one row, resolved through a list.

The list is required, not optional: it decides whether record_id names a contact or a company and which list-scoped custom columns apply. Reading the same id through two different lists can legitimately return different columns.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Read every column value for ONE row, resolved against a list.

The list decides whether record_id is read as a contact or a company, and which list-scoped custom columns are in play - which is why it is required rather than inferred.

object
list_id
required

List the record is read through.

integer
record_id
required

Record primary key.

integer

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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