Skip to content

List Base Columns

GET
/contacts/base-columns

The real DATABASE columns behind a list.

Excludes the composite and enrichment columns the grid displays, so what comes back is what can actually be written to and filtered on.

Authorizations

Parameters

Query Parameters

list_id
required

Required: the list decides which base columns exist.

integer

Required: the list decides which base columns exist.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
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