Skip to content

List Contact Fields

GET
/fields

List contact fields (base + custom). Optionally include list-specific custom fields.

Authorizations

Parameters

Query Parameters

list_id
Any of:
integer

List ID to include list-specific custom fields

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>
object
data_type
string
default: text
id
Any of:
integer
is_global
boolean
default: true
name
Any of:
string
title
required
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