Properties keyed by property slug. Values can be strings, numbers, booleans, arrays, or null. For select/multiselect properties, values may be option slugs or option UUIDs on write; option slugs are returned on read.

list: Optional[object]

class ContactCreateResponse: …

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

class ContactListResponse: …

data: List[Data]

id: str
formatuuid

is_user_object: Optional[bool]

properties: Optional[Dict[str, object]]

Selected property values keyed by property slug. For select/multiselect properties, option slugs are returned. For reference properties, values are nested { id, properties } objects.

source: Optional[str]
formatuuid

has_more: bool

Accurate end-of-data signal — false on the last page, never forces clients to overshoot.

next_cursor: Optional[str]

total: Optional[int]

Populated only when ?include_total=true was passed.

class ContactGetResponse: …

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

class ContactUpdateResponse: …

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

class ContactQueryResponse: …

data: List[Data]

id: str
formatuuid

is_user_object: Optional[bool]

properties: Optional[Dict[str, object]]

Selected property values keyed by property slug. For select/multiselect properties, option slugs are returned. For reference properties, values are nested { id, properties } objects.

source: Optional[str]
formatuuid

has_more: bool

Accurate end-of-data signal. False when this page contains the last record; true only when at least one more record exists. (Implementation note: the server fetches one extra row internally to determine this — clients never need to overshoot to discover the end.)

next_cursor: Optional[str]

Opaque cursor pointing at the next page. Pass it back unchanged in the request body (cursor) of the next call. Null when has_more is false.

total: Optional[int]

Only populated when the request set include_total: true. Total number of records matching the query, ignoring pagination. Opt-in because it costs an additional pass over the result set.

class ContactCountResponse: …

total: int

Number of records matching the access scope.

class ContactFindResponse: …

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

class ContactUpsertResponse: …

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

class ContactBulkCreateResponse: …

Status snapshot of an import job. Same shape used by the POST /import response and by GET /imports/{jobId}.

job_id: Optional[str]

Null for sync imports (results inlined). Set for async imports.

status: Literal["complete", "processing", "failed"]

One of the following:

"complete"

"processing"

"failed"

total: int

Total number of rows in the import.

created_at: Optional[datetime]
formatdate-time

error: Optional[Error]

Set when status=failed; describes the job-level failure (not per-row).

code: Optional[str]

message: Optional[str]

expires_at: Optional[datetime]
formatdate-time

failed: Optional[int]

processed: Optional[int]

Rows that have been attempted (succeeded + failed).

results: Optional[List[Result]]

Per-row outcomes. Always present for sync imports; populated for async imports once the job reaches complete.

id: Optional[str]
formatuuid

created: Optional[bool]

error: Optional[ResultError]

code: Optional[str]

message: Optional[str]

existing: Optional[bool]

True if the row matched an existing record via the dedupe key.

succeeded: Optional[int]

updated_at: Optional[datetime]
formatdate-time

class ContactBulkUpdateResponse: …

Partial-success bulk operation result. Inspect results[].status per item; the operation as a whole returns 200 even if some items failed.

results: List[Result]

id: Optional[str]

Item ID, or null if the input was unparseable.

status: Literal["ok", "error"]

One of the following:

"ok"

"error"

error: Optional[ResultError]

code: Optional[str]

message: Optional[str]

record: Optional[ResultRecord]

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

summary: Summary

failed: int

succeeded: int

total: int

class ContactBulkDeleteResponse: …

Partial-success bulk operation result. Inspect results[].status per item; the operation as a whole returns 200 even if some items failed.

results: List[Result]

id: Optional[str]

Item ID, or null if the input was unparseable.

status: Literal["ok", "error"]

One of the following:

"ok"

"error"

error: Optional[ResultError]

code: Optional[str]

message: Optional[str]

record: Optional[ResultRecord]

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

summary: Summary

failed: int

succeeded: int

total: int

class ContactDuplicateResponse: …

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

class ContactRestoreResponse: …

Object returned by reads (get/create/patch/restore). id is always present.

id: str
formatuuid

default: Optional[Dict[str, object]]

Properties keyed by property slug.

list: Optional[object]

Contacts

ModelsExpand Collapse

What can I help you with?