Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Body

application/json

Request body for creating a list.

name
string
required

Name of the list. Must be unique within the workspace.

Required string length: 1 - 255
object
string
required

API name of the object whose records the list will hold. Cannot be changed after creation.

share_status
enum<string>

Who can see and change the list. Defaults to ONLY_ME.

Available options:
ONLY_ME,
ALL_OTHERS_CAN_VIEW,
ALL_OTHERS_CAN_EDIT

Response

Response for a successful create operation.

Response for a successful create operation.

status
enum<string>
required
Available options:
success
data
object
required

A list is a named, hand-curated set of records of a single object, for example a set of company records to target this quarter. Lists are owned by a user and shared according to share_status.