API Reference

Prism

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Objects

ObjectsContacts

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

ObjectsOrganizations

Create object

client.prism.objects.organizations.create(OrganizationCreateParams { teamId, _default, list, idempotencyKey } params?, RequestOptionsoptions?): OrganizationCreateResponse { id, default, list }

POST/v2/prism/{teamId}/organization

List records of an object type

client.prism.objects.organizations.list(OrganizationListParams { teamId, cursor, deleted, 5 more } params?, RequestOptionsoptions?): OrganizationListResponse { data, has_more, next_cursor, total }

GET/v2/prism/{teamId}/organization

Get object

client.prism.objects.organizations.get(stringorganizationID, OrganizationGetParams { teamId, select } params?, RequestOptionsoptions?): OrganizationGetResponse { id, default, list }

GET/v2/prism/{teamId}/organization/{organizationId}

Patch object

client.prism.objects.organizations.update(stringorganizationID, OrganizationUpdateParams { teamId, _default, list, 2 more } params, RequestOptionsoptions?): OrganizationUpdateResponse { id, default, list }

PATCH/v2/prism/{teamId}/organization/{organizationId}

Delete object

client.prism.objects.organizations.delete(stringorganizationID, OrganizationDeleteParams { teamId, ifMatch } params?, RequestOptionsoptions?): void

DELETE/v2/prism/{teamId}/organization/{organizationId}

Query

client.prism.objects.organizations.query(OrganizationQueryParams { teamId, query, id, 5 more } params, RequestOptionsoptions?): OrganizationQueryResponse { data, has_more, next_cursor, total }

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

Total record count for an object type

client.prism.objects.organizations.count(OrganizationCountParams { teamId, list_id } params?, RequestOptionsoptions?): OrganizationCountResponse { total }

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

Find a record by property value

client.prism.objects.organizations.find(stringvalue, OrganizationFindParams { teamId, slug, list_id } params, RequestOptionsoptions?): OrganizationFindResponse { id, default, list }

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

Upsert by property value

client.prism.objects.organizations.upsert(stringvalue, OrganizationUpsertParams { teamId, slug, _default, 2 more } params, RequestOptionsoptions?): OrganizationUpsertResponse { id, default, list }

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

Import objects

client.prism.objects.organizations.bulkCreate(OrganizationBulkCreateParams { teamId, objects, options, idempotencyKey } params, RequestOptionsoptions?): OrganizationBulkCreateResponse { job_id, status, total, 8 more }

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

Bulk update records (partial success)

client.prism.objects.organizations.bulkUpdate(OrganizationBulkUpdateParams { teamId, items, idempotencyKey } params, RequestOptionsoptions?): OrganizationBulkUpdateResponse { results, summary }

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

Bulk delete records (partial success)

client.prism.objects.organizations.bulkDelete(OrganizationBulkDeleteParams { teamId, ids, idempotencyKey } params, RequestOptionsoptions?): OrganizationBulkDeleteResponse { results, summary }

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

Duplicate object

client.prism.objects.organizations.duplicate(stringorganizationID, OrganizationDuplicateParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): OrganizationDuplicateResponse { id, default, list }

POST/v2/prism/{teamId}/organization/{organizationId}/duplicate

Restore object

client.prism.objects.organizations.restore(stringorganizationID, OrganizationRestoreParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): OrganizationRestoreResponse { id, default, list }

POST/v2/prism/{teamId}/organization/{organizationId}/restore

ModelsExpand Collapse

Organization { 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

OrganizationCreateResponse { 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

OrganizationListResponse { 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.

OrganizationGetResponse { 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

OrganizationUpdateResponse { 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

OrganizationQueryResponse { 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.

OrganizationCountResponse { total }

total: number

Number of records matching the access scope.

OrganizationFindResponse { 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

OrganizationUpsertResponse { 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

OrganizationBulkCreateResponse { 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

OrganizationBulkUpdateResponse { 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

OrganizationBulkDeleteResponse { 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

OrganizationDuplicateResponse { 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

OrganizationRestoreResponse { 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

ObjectsIdentities

Create object

client.prism.objects.identities.create(IdentityCreateParams { teamId, _default, list, idempotencyKey } params?, RequestOptionsoptions?): IdentityCreateResponse { id, default, list }

POST/v2/prism/{teamId}/identity

List records of an object type

client.prism.objects.identities.list(IdentityListParams { teamId, cursor, deleted, 5 more } params?, RequestOptionsoptions?): IdentityListResponse { data, has_more, next_cursor, total }

GET/v2/prism/{teamId}/identity

Get object

client.prism.objects.identities.get(stringidentityID, IdentityGetParams { teamId, select } params?, RequestOptionsoptions?): IdentityGetResponse { id, default, list }

GET/v2/prism/{teamId}/identity/{identityId}

Patch object

client.prism.objects.identities.update(stringidentityID, IdentityUpdateParams { teamId, _default, list, 2 more } params, RequestOptionsoptions?): IdentityUpdateResponse { id, default, list }

PATCH/v2/prism/{teamId}/identity/{identityId}

Delete object

client.prism.objects.identities.delete(stringidentityID, IdentityDeleteParams { teamId, ifMatch } params?, RequestOptionsoptions?): void

DELETE/v2/prism/{teamId}/identity/{identityId}

Query

client.prism.objects.identities.query(IdentityQueryParams { teamId, query, id, 5 more } params, RequestOptionsoptions?): IdentityQueryResponse { data, has_more, next_cursor, total }

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

Total record count for an object type

client.prism.objects.identities.count(IdentityCountParams { teamId, list_id } params?, RequestOptionsoptions?): IdentityCountResponse { total }

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

Find a record by property value

client.prism.objects.identities.find(stringvalue, IdentityFindParams { teamId, slug, list_id } params, RequestOptionsoptions?): IdentityFindResponse { id, default, list }

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

Upsert by property value

client.prism.objects.identities.upsert(stringvalue, IdentityUpsertParams { teamId, slug, _default, 2 more } params, RequestOptionsoptions?): IdentityUpsertResponse { id, default, list }

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

Import objects

client.prism.objects.identities.bulkCreate(IdentityBulkCreateParams { teamId, objects, options, idempotencyKey } params, RequestOptionsoptions?): IdentityBulkCreateResponse { job_id, status, total, 8 more }

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

Bulk update records (partial success)

client.prism.objects.identities.bulkUpdate(IdentityBulkUpdateParams { teamId, items, idempotencyKey } params, RequestOptionsoptions?): IdentityBulkUpdateResponse { results, summary }

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

Bulk delete records (partial success)

client.prism.objects.identities.bulkDelete(IdentityBulkDeleteParams { teamId, ids, idempotencyKey } params, RequestOptionsoptions?): IdentityBulkDeleteResponse { results, summary }

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

Duplicate object

client.prism.objects.identities.duplicate(stringidentityID, IdentityDuplicateParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): IdentityDuplicateResponse { id, default, list }

POST/v2/prism/{teamId}/identity/{identityId}/duplicate

Restore object

client.prism.objects.identities.restore(stringidentityID, IdentityRestoreParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): IdentityRestoreResponse { id, default, list }

POST/v2/prism/{teamId}/identity/{identityId}/restore

ModelsExpand Collapse

Identity { 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

IdentityCreateResponse { 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

IdentityListResponse { 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.

IdentityGetResponse { 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

IdentityUpdateResponse { 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

IdentityQueryResponse { 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.

IdentityCountResponse { total }

total: number

Number of records matching the access scope.

IdentityFindResponse { 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

IdentityUpsertResponse { 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

IdentityBulkCreateResponse { 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

IdentityBulkUpdateResponse { 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

IdentityBulkDeleteResponse { 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

IdentityDuplicateResponse { 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

IdentityRestoreResponse { 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

ObjectsDeals

Create object

client.prism.objects.deals.create(DealCreateParams { teamId, _default, list, idempotencyKey } params?, RequestOptionsoptions?): DealCreateResponse { id, default, list }

POST/v2/prism/{teamId}/deal

List records of an object type

client.prism.objects.deals.list(DealListParams { teamId, cursor, deleted, 5 more } params?, RequestOptionsoptions?): DealListResponse { data, has_more, next_cursor, total }

GET/v2/prism/{teamId}/deal

Get object

client.prism.objects.deals.get(stringdealID, DealGetParams { teamId, select } params?, RequestOptionsoptions?): DealGetResponse { id, default, list }

GET/v2/prism/{teamId}/deal/{dealId}

Patch object

client.prism.objects.deals.update(stringdealID, DealUpdateParams { teamId, _default, list, 2 more } params, RequestOptionsoptions?): DealUpdateResponse { id, default, list }

PATCH/v2/prism/{teamId}/deal/{dealId}

Delete object

client.prism.objects.deals.delete(stringdealID, DealDeleteParams { teamId, ifMatch } params?, RequestOptionsoptions?): void

DELETE/v2/prism/{teamId}/deal/{dealId}

Query

client.prism.objects.deals.query(DealQueryParams { teamId, query, id, 5 more } params, RequestOptionsoptions?): DealQueryResponse { data, has_more, next_cursor, total }

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

Total record count for an object type

client.prism.objects.deals.count(DealCountParams { teamId, list_id } params?, RequestOptionsoptions?): DealCountResponse { total }

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

Find a record by property value

client.prism.objects.deals.find(stringvalue, DealFindParams { teamId, slug, list_id } params, RequestOptionsoptions?): DealFindResponse { id, default, list }

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

Upsert by property value

client.prism.objects.deals.upsert(stringvalue, DealUpsertParams { teamId, slug, _default, 2 more } params, RequestOptionsoptions?): DealUpsertResponse { id, default, list }

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

Import objects

client.prism.objects.deals.bulkCreate(DealBulkCreateParams { teamId, objects, options, idempotencyKey } params, RequestOptionsoptions?): DealBulkCreateResponse { job_id, status, total, 8 more }

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

Bulk update records (partial success)

client.prism.objects.deals.bulkUpdate(DealBulkUpdateParams { teamId, items, idempotencyKey } params, RequestOptionsoptions?): DealBulkUpdateResponse { results, summary }

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

Bulk delete records (partial success)

client.prism.objects.deals.bulkDelete(DealBulkDeleteParams { teamId, ids, idempotencyKey } params, RequestOptionsoptions?): DealBulkDeleteResponse { results, summary }

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

Duplicate object

client.prism.objects.deals.duplicate(stringdealID, DealDuplicateParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): DealDuplicateResponse { id, default, list }

POST/v2/prism/{teamId}/deal/{dealId}/duplicate

Restore object

client.prism.objects.deals.restore(stringdealID, DealRestoreParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): DealRestoreResponse { id, default, list }

POST/v2/prism/{teamId}/deal/{dealId}/restore

ModelsExpand Collapse

Deal { 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

DealCreateResponse { 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

DealListResponse { 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.

DealGetResponse { 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

DealUpdateResponse { 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

DealQueryResponse { 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.

DealCountResponse { total }

total: number

Number of records matching the access scope.

DealFindResponse { 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

DealUpsertResponse { 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

DealBulkCreateResponse { 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

DealBulkUpdateResponse { 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

DealBulkDeleteResponse { 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

DealDuplicateResponse { 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

DealRestoreResponse { 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

ObjectsDealsGrant

Get grant

client.prism.objects.deals.grant.get(stringdealID, GrantGetParams { teamId } params?, RequestOptionsoptions?): GrantGetResponse { team_group_id, team_id, user_id }

GET/v2/prism/{teamId}/deal/{dealId}/grant

Update grant

client.prism.objects.deals.grant.update(stringdealID, GrantUpdateParams { teamId, team_group_id, team_id, 2 more } params, RequestOptionsoptions?): GrantUpdateResponse { team_group_id, team_id, user_id }

PUT/v2/prism/{teamId}/deal/{dealId}/grant

ModelsExpand Collapse

GrantGetResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

GrantUpdateResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

ObjectsActions

Create object

client.prism.objects.actions.create(ActionCreateParams { teamId, _default, list, idempotencyKey } params?, RequestOptionsoptions?): ActionCreateResponse { id, default, list }

POST/v2/prism/{teamId}/action

List records of an object type

client.prism.objects.actions.list(ActionListParams { teamId, cursor, deleted, 5 more } params?, RequestOptionsoptions?): ActionListResponse { data, has_more, next_cursor, total }

GET/v2/prism/{teamId}/action

Get object

client.prism.objects.actions.get(stringactionID, ActionGetParams { teamId, select } params?, RequestOptionsoptions?): ActionGetResponse { id, default, list }

GET/v2/prism/{teamId}/action/{actionId}

Patch object

client.prism.objects.actions.update(stringactionID, ActionUpdateParams { teamId, _default, list, 2 more } params, RequestOptionsoptions?): ActionUpdateResponse { id, default, list }

PATCH/v2/prism/{teamId}/action/{actionId}

Delete object

client.prism.objects.actions.delete(stringactionID, ActionDeleteParams { teamId, ifMatch } params?, RequestOptionsoptions?): void

DELETE/v2/prism/{teamId}/action/{actionId}

Query

client.prism.objects.actions.query(ActionQueryParams { teamId, query, id, 5 more } params, RequestOptionsoptions?): ActionQueryResponse { data, has_more, next_cursor, total }

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

Total record count for an object type

client.prism.objects.actions.count(ActionCountParams { teamId, list_id } params?, RequestOptionsoptions?): ActionCountResponse { total }

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

Find a record by property value

client.prism.objects.actions.find(stringvalue, ActionFindParams { teamId, slug, list_id } params, RequestOptionsoptions?): ActionFindResponse { id, default, list }

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

Upsert by property value

client.prism.objects.actions.upsert(stringvalue, ActionUpsertParams { teamId, slug, _default, 2 more } params, RequestOptionsoptions?): ActionUpsertResponse { id, default, list }

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

Import objects

client.prism.objects.actions.bulkCreate(ActionBulkCreateParams { teamId, objects, options, idempotencyKey } params, RequestOptionsoptions?): ActionBulkCreateResponse { job_id, status, total, 8 more }

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

Bulk update records (partial success)

client.prism.objects.actions.bulkUpdate(ActionBulkUpdateParams { teamId, items, idempotencyKey } params, RequestOptionsoptions?): ActionBulkUpdateResponse { results, summary }

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

Bulk delete records (partial success)

client.prism.objects.actions.bulkDelete(ActionBulkDeleteParams { teamId, ids, idempotencyKey } params, RequestOptionsoptions?): ActionBulkDeleteResponse { results, summary }

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

Duplicate object

client.prism.objects.actions.duplicate(stringactionID, ActionDuplicateParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): ActionDuplicateResponse { id, default, list }

POST/v2/prism/{teamId}/action/{actionId}/duplicate

Restore object

client.prism.objects.actions.restore(stringactionID, ActionRestoreParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): ActionRestoreResponse { id, default, list }

POST/v2/prism/{teamId}/action/{actionId}/restore

ModelsExpand Collapse

Action { 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

ActionCreateResponse { 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

ActionListResponse { 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.

ActionGetResponse { 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

ActionUpdateResponse { 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

ActionQueryResponse { 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.

ActionCountResponse { total }

total: number

Number of records matching the access scope.

ActionFindResponse { 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

ActionUpsertResponse { 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

ActionBulkCreateResponse { 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

ActionBulkUpdateResponse { 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

ActionBulkDeleteResponse { 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

ActionDuplicateResponse { 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

ActionRestoreResponse { 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

ObjectsActionsGrant

Get grant

client.prism.objects.actions.grant.get(stringactionID, GrantGetParams { teamId } params?, RequestOptionsoptions?): GrantGetResponse { team_group_id, team_id, user_id }

GET/v2/prism/{teamId}/action/{actionId}/grant

Update grant

client.prism.objects.actions.grant.update(stringactionID, GrantUpdateParams { teamId, team_group_id, team_id, 2 more } params, RequestOptionsoptions?): GrantUpdateResponse { team_group_id, team_id, user_id }

PUT/v2/prism/{teamId}/action/{actionId}/grant

ModelsExpand Collapse

GrantGetResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

GrantUpdateResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

ObjectsDocuments

Create object

client.prism.objects.documents.create(DocumentCreateParams { teamId, _default, list, idempotencyKey } params?, RequestOptionsoptions?): DocumentCreateResponse { id, default, list }

POST/v2/prism/{teamId}/document

List records of an object type

client.prism.objects.documents.list(DocumentListParams { teamId, cursor, deleted, 5 more } params?, RequestOptionsoptions?): DocumentListResponse { data, has_more, next_cursor, total }

GET/v2/prism/{teamId}/document

Get object

client.prism.objects.documents.get(stringdocumentID, DocumentGetParams { teamId, select } params?, RequestOptionsoptions?): DocumentGetResponse { id, default, list }

GET/v2/prism/{teamId}/document/{documentId}

Patch object

client.prism.objects.documents.update(stringdocumentID, DocumentUpdateParams { teamId, _default, list, 2 more } params, RequestOptionsoptions?): DocumentUpdateResponse { id, default, list }

PATCH/v2/prism/{teamId}/document/{documentId}

Delete object

client.prism.objects.documents.delete(stringdocumentID, DocumentDeleteParams { teamId, ifMatch } params?, RequestOptionsoptions?): void

DELETE/v2/prism/{teamId}/document/{documentId}

Query

client.prism.objects.documents.query(DocumentQueryParams { teamId, query, id, 5 more } params, RequestOptionsoptions?): DocumentQueryResponse { data, has_more, next_cursor, total }

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

Total record count for an object type

client.prism.objects.documents.count(DocumentCountParams { teamId, list_id } params?, RequestOptionsoptions?): DocumentCountResponse { total }

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

Find a record by property value

client.prism.objects.documents.find(stringvalue, DocumentFindParams { teamId, slug, list_id } params, RequestOptionsoptions?): DocumentFindResponse { id, default, list }

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

Upsert by property value

client.prism.objects.documents.upsert(stringvalue, DocumentUpsertParams { teamId, slug, _default, 2 more } params, RequestOptionsoptions?): DocumentUpsertResponse { id, default, list }

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

Import objects

client.prism.objects.documents.bulkCreate(DocumentBulkCreateParams { teamId, objects, options, idempotencyKey } params, RequestOptionsoptions?): DocumentBulkCreateResponse { job_id, status, total, 8 more }

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

Bulk update records (partial success)

client.prism.objects.documents.bulkUpdate(DocumentBulkUpdateParams { teamId, items, idempotencyKey } params, RequestOptionsoptions?): DocumentBulkUpdateResponse { results, summary }

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

Bulk delete records (partial success)

client.prism.objects.documents.bulkDelete(DocumentBulkDeleteParams { teamId, ids, idempotencyKey } params, RequestOptionsoptions?): DocumentBulkDeleteResponse { results, summary }

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

Duplicate object

client.prism.objects.documents.duplicate(stringdocumentID, DocumentDuplicateParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): DocumentDuplicateResponse { id, default, list }

POST/v2/prism/{teamId}/document/{documentId}/duplicate

Restore object

client.prism.objects.documents.restore(stringdocumentID, DocumentRestoreParams { teamId, idempotencyKey } params?, RequestOptionsoptions?): DocumentRestoreResponse { id, default, list }

POST/v2/prism/{teamId}/document/{documentId}/restore

ModelsExpand Collapse

Document { 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

DocumentCreateResponse { 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

DocumentListResponse { 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.

DocumentGetResponse { 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

DocumentUpdateResponse { 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

DocumentQueryResponse { 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.

DocumentCountResponse { total }

total: number

Number of records matching the access scope.

DocumentFindResponse { 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

DocumentUpsertResponse { 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

DocumentBulkCreateResponse { 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

DocumentBulkUpdateResponse { 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

DocumentBulkDeleteResponse { 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

DocumentDuplicateResponse { 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

DocumentRestoreResponse { 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

ObjectsDocumentsGrant

Get grant

client.prism.objects.documents.grant.get(stringdocumentID, GrantGetParams { teamId } params?, RequestOptionsoptions?): GrantGetResponse { team_group_id, team_id, user_id }

GET/v2/prism/{teamId}/document/{documentId}/grant

Update grant

client.prism.objects.documents.grant.update(stringdocumentID, GrantUpdateParams { teamId, team_group_id, team_id, 2 more } params, RequestOptionsoptions?): GrantUpdateResponse { team_group_id, team_id, user_id }

PUT/v2/prism/{teamId}/document/{documentId}/grant

ModelsExpand Collapse

GrantGetResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

GrantUpdateResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

ObjectsEvents

List records of an object type

client.prism.objects.events.list(EventListParams { teamId, cursor, deleted, 5 more } params?, RequestOptionsoptions?): EventListResponse { data, has_more, next_cursor, total }

GET/v2/prism/{teamId}/event

Get object

client.prism.objects.events.get(stringeventID, EventGetParams { teamId, select } params?, RequestOptionsoptions?): EventGetResponse { id, default, list }

GET/v2/prism/{teamId}/event/{eventId}

Query

client.prism.objects.events.query(EventQueryParams { teamId, query, id, 5 more } params, RequestOptionsoptions?): EventQueryResponse { data, has_more, next_cursor, total }

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

Total record count for an object type

client.prism.objects.events.count(EventCountParams { teamId, list_id } params?, RequestOptionsoptions?): EventCountResponse { total }

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

Find a record by property value

client.prism.objects.events.find(stringvalue, EventFindParams { teamId, slug, list_id } params, RequestOptionsoptions?): EventFindResponse { id, default, list }

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

ModelsExpand Collapse

Event { 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

EventListResponse { 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.

EventGetResponse { 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

EventQueryResponse { 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.

EventCountResponse { total }

total: number

Number of records matching the access scope.

EventFindResponse { 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

ObjectsEventsGrant

Get grant

client.prism.objects.events.grant.get(stringeventID, GrantGetParams { teamId } params?, RequestOptionsoptions?): GrantGetResponse { team_group_id, team_id, user_id }

GET/v2/prism/{teamId}/event/{eventId}/grant

Update grant

client.prism.objects.events.grant.update(stringeventID, GrantUpdateParams { teamId, team_group_id, team_id, 2 more } params, RequestOptionsoptions?): GrantUpdateResponse { team_group_id, team_id, user_id }

PUT/v2/prism/{teamId}/event/{eventId}/grant

ModelsExpand Collapse

GrantGetResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

GrantUpdateResponse { team_group_id, team_id, user_id }

team_group_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"

team_id?: Record<string, "a" | "r" | "w">

One of the following:

"a"

"r"

"w"

user_id?: Array<Record<string, "a" | "r" | "w">>

One of the following:

"a"

"r"

"w"