API Reference

Prism

Objects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Contacts

Create object

client.prism.objects.contacts.create(ContactCreateParams { teamId, _default, list, idempotencyKey } params?, RequestOptionsoptions?): ContactCreateResponse { id, default, list }

POST/v2/prism/{teamId}/contact

List records of an object type

client.prism.objects.contacts.list(ContactListParams { teamId, cursor, deleted, 5 more } params?, RequestOptionsoptions?): ContactListResponse { data, has_more, next_cursor, total }

GET/v2/prism/{teamId}/contact

Get object

client.prism.objects.contacts.get(stringcontactID, ContactGetParams { teamId, select } params?, RequestOptionsoptions?): ContactGetResponse { id, default, list }

GET/v2/prism/{teamId}/contact/{contactId}

Patch object

client.prism.objects.contacts.update(stringcontactID, ContactUpdateParams { teamId, _default, list, 2 more } params, RequestOptionsoptions?): ContactUpdateResponse { id, default, list }

PATCH/v2/prism/{teamId}/contact/{contactId}

Delete object

client.prism.objects.contacts.delete(stringcontactID, ContactDeleteParams { teamId, ifMatch } params?, RequestOptionsoptions?): void

DELETE/v2/prism/{teamId}/contact/{contactId}

Query

client.prism.objects.contacts.query(ContactQueryParams { teamId, query, id, 5 more } params, RequestOptionsoptions?): ContactQueryResponse { data, has_more, next_cursor, total }

POST/v2/prism/{teamId}/contact/query

Total record count for an object type

client.prism.objects.contacts.count(ContactCountParams { teamId, list_id } params?, RequestOptionsoptions?): ContactCountResponse { total }

GET/v2/prism/{teamId}/contact/count

Find a record by property value

client.prism.objects.contacts.find(stringvalue, ContactFindParams { teamId, slug, list_id } params, RequestOptionsoptions?): ContactFindResponse { id, default, list }

GET/v2/prism/{teamId}/contact/by/{slug}/{value}

Upsert by property value

client.prism.objects.contacts.upsert(stringvalue, ContactUpsertParams { teamId, slug, _default, 2 more } params, RequestOptionsoptions?): ContactUpsertResponse { id, default, list }

PUT/v2/prism/{teamId}/contact/by/{slug}/{value}

Import objects

client.prism.objects.contacts.bulkCreate(ContactBulkCreateParams { teamId, objects, options, idempotencyKey } params, RequestOptionsoptions?): ContactBulkCreateResponse { job_id, status, total, 8 more }

POST/v2/prism/{teamId}/contact/import

Bulk update records (partial success)

client.prism.objects.contacts.bulkUpdate(ContactBulkUpdateParams { teamId, items, idempotencyKey } params, RequestOptionsoptions?): ContactBulkUpdateResponse { results, summary }

POST/v2/prism/{teamId}/contact/batch/update

Bulk delete records (partial success)

client.prism.objects.contacts.bulkDelete(ContactBulkDeleteParams { teamId, ids, idempotencyKey } params, RequestOptionsoptions?): ContactBulkDeleteResponse { results, summary }

POST/v2/prism/{teamId}/contact/batch/delete

Duplicate object

client.prism.objects.contacts.duplicate(stringcontactID, ContactDuplicateParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): ContactDuplicateResponse { id, default, list }

POST/v2/prism/{teamId}/contact/{contactId}/duplicate

Restore object

client.prism.objects.contacts.restore(stringcontactID, ContactRestoreParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): ContactRestoreResponse { id, default, list }

POST/v2/prism/{teamId}/contact/{contactId}/restore

ModelsExpand Collapse

Contact { default, list }

default?: Record<string, unknown>

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?: unknown

ContactCreateResponse { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

ContactListResponse { data, has_more, next_cursor, total }

data: Array<Data>

id: string

formatuuid

is_user_object?: boolean

properties?: Record<string, unknown>

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?: string | null

formatuuid

has_more: boolean

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

next_cursor?: string | null

total?: number | null

Populated only when ?include_total=true was passed.

ContactGetResponse { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

ContactUpdateResponse { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

ContactQueryResponse { data, has_more, next_cursor, total }

data: Array<Data>

id: string

formatuuid

is_user_object?: boolean

properties?: Record<string, unknown>

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?: string | null

formatuuid

has_more: boolean

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?: string | null

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?: number | null

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.

ContactCountResponse { total }

total: number

Number of records matching the access scope.

ContactFindResponse { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

ContactUpsertResponse { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

ContactBulkCreateResponse { job_id, status, total, 8 more }

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

job_id: string | null

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

status: "complete" | "processing" | "failed"

One of the following:

"complete"

"processing"

"failed"

total: number

Total number of rows in the import.

created_at?: string

formatdate-time

error?: Error { code, message }

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

code?: string

message?: string

expires_at?: string

formatdate-time

failed?: number

processed?: number

Rows that have been attempted (succeeded + failed).

results?: Array<Result>

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

id?: string | null

formatuuid

created?: boolean

error?: Error { code, message }

code?: string

message?: string

existing?: boolean

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

succeeded?: number

updated_at?: string

formatdate-time

ContactBulkUpdateResponse { results, summary }

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

results: Array<Result>

id: string | null

Item ID, or null if the input was unparseable.

status: "ok" | "error"

One of the following:

"ok"

"error"

error?: Error { code, message }

code?: string

message?: string

record?: Record { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

summary: Summary { failed, succeeded, total }

failed: number

succeeded: number

total: number

ContactBulkDeleteResponse { results, summary }

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

results: Array<Result>

id: string | null

Item ID, or null if the input was unparseable.

status: "ok" | "error"

One of the following:

"ok"

"error"

error?: Error { code, message }

code?: string

message?: string

record?: Record { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

summary: Summary { failed, succeeded, total }

failed: number

succeeded: number

total: number

ContactDuplicateResponse { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown

ContactRestoreResponse { id, default, list }

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

id: string

formatuuid

default?: Record<string, unknown>

Properties keyed by property slug.

list?: unknown