API Reference

Prism

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Objects

ObjectsContacts

Create object

prism.objects.contacts.create(ContactCreateParams**kwargs) -> ContactCreateResponse

POST/v2/prism/{teamId}/contact

List records of an object type

prism.objects.contacts.list(ContactListParams**kwargs) -> ContactListResponse

GET/v2/prism/{teamId}/contact

Get object

prism.objects.contacts.get(strcontact_id, ContactGetParams**kwargs) -> ContactGetResponse

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

Patch object

prism.objects.contacts.update(strcontact_id, ContactUpdateParams**kwargs) -> ContactUpdateResponse

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

Delete object

prism.objects.contacts.delete(strcontact_id, ContactDeleteParams**kwargs)

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

Query

prism.objects.contacts.query(ContactQueryParams**kwargs) -> ContactQueryResponse

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

Total record count for an object type

prism.objects.contacts.count(ContactCountParams**kwargs) -> ContactCountResponse

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

Find a record by property value

prism.objects.contacts.find(strvalue, ContactFindParams**kwargs) -> ContactFindResponse

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

Upsert by property value

prism.objects.contacts.upsert(strvalue, ContactUpsertParams**kwargs) -> ContactUpsertResponse

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

Import objects

prism.objects.contacts.bulk_create(ContactBulkCreateParams**kwargs) -> ContactBulkCreateResponse

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

Bulk update records (partial success)

prism.objects.contacts.bulk_update(ContactBulkUpdateParams**kwargs) -> ContactBulkUpdateResponse

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

Bulk delete records (partial success)

prism.objects.contacts.bulk_delete(ContactBulkDeleteParams**kwargs) -> ContactBulkDeleteResponse

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

Duplicate object

prism.objects.contacts.duplicate(strcontact_id, ContactDuplicateParams**kwargs) -> ContactDuplicateResponse

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

Restore object

prism.objects.contacts.restore(strcontact_id, ContactRestoreParams**kwargs) -> ContactRestoreResponse

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

ModelsExpand Collapse

class Contact: …

default: Optional[Dict[str, object]]

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]

ObjectsOrganizations

Create object

prism.objects.organizations.create(OrganizationCreateParams**kwargs) -> OrganizationCreateResponse

POST/v2/prism/{teamId}/organization

List records of an object type

prism.objects.organizations.list(OrganizationListParams**kwargs) -> OrganizationListResponse

GET/v2/prism/{teamId}/organization

Get object

prism.objects.organizations.get(strorganization_id, OrganizationGetParams**kwargs) -> OrganizationGetResponse

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

Patch object

prism.objects.organizations.update(strorganization_id, OrganizationUpdateParams**kwargs) -> OrganizationUpdateResponse

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

Delete object

prism.objects.organizations.delete(strorganization_id, OrganizationDeleteParams**kwargs)

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

Query

prism.objects.organizations.query(OrganizationQueryParams**kwargs) -> OrganizationQueryResponse

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

Total record count for an object type

prism.objects.organizations.count(OrganizationCountParams**kwargs) -> OrganizationCountResponse

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

Find a record by property value

prism.objects.organizations.find(strvalue, OrganizationFindParams**kwargs) -> OrganizationFindResponse

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

Upsert by property value

prism.objects.organizations.upsert(strvalue, OrganizationUpsertParams**kwargs) -> OrganizationUpsertResponse

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

Import objects

prism.objects.organizations.bulk_create(OrganizationBulkCreateParams**kwargs) -> OrganizationBulkCreateResponse

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

Bulk update records (partial success)

prism.objects.organizations.bulk_update(OrganizationBulkUpdateParams**kwargs) -> OrganizationBulkUpdateResponse

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

Bulk delete records (partial success)

prism.objects.organizations.bulk_delete(OrganizationBulkDeleteParams**kwargs) -> OrganizationBulkDeleteResponse

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

Duplicate object

prism.objects.organizations.duplicate(strorganization_id, OrganizationDuplicateParams**kwargs) -> OrganizationDuplicateResponse

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

Restore object

prism.objects.organizations.restore(strorganization_id, OrganizationRestoreParams**kwargs) -> OrganizationRestoreResponse

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

ModelsExpand Collapse

class Organization: …

default: Optional[Dict[str, object]]

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 OrganizationCreateResponse: …

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 OrganizationListResponse: …

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 OrganizationGetResponse: …

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 OrganizationUpdateResponse: …

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 OrganizationQueryResponse: …

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 OrganizationCountResponse: …

total: int

Number of records matching the access scope.

class OrganizationFindResponse: …

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 OrganizationUpsertResponse: …

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 OrganizationBulkCreateResponse: …

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 OrganizationBulkUpdateResponse: …

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 OrganizationBulkDeleteResponse: …

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 OrganizationDuplicateResponse: …

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 OrganizationRestoreResponse: …

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]

ObjectsIdentities

Create object

prism.objects.identities.create(IdentityCreateParams**kwargs) -> IdentityCreateResponse

POST/v2/prism/{teamId}/identity

List records of an object type

prism.objects.identities.list(IdentityListParams**kwargs) -> IdentityListResponse

GET/v2/prism/{teamId}/identity

Get object

prism.objects.identities.get(stridentity_id, IdentityGetParams**kwargs) -> IdentityGetResponse

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

Patch object

prism.objects.identities.update(stridentity_id, IdentityUpdateParams**kwargs) -> IdentityUpdateResponse

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

Delete object

prism.objects.identities.delete(stridentity_id, IdentityDeleteParams**kwargs)

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

Query

prism.objects.identities.query(IdentityQueryParams**kwargs) -> IdentityQueryResponse

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

Total record count for an object type

prism.objects.identities.count(IdentityCountParams**kwargs) -> IdentityCountResponse

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

Find a record by property value

prism.objects.identities.find(strvalue, IdentityFindParams**kwargs) -> IdentityFindResponse

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

Upsert by property value

prism.objects.identities.upsert(strvalue, IdentityUpsertParams**kwargs) -> IdentityUpsertResponse

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

Import objects

prism.objects.identities.bulk_create(IdentityBulkCreateParams**kwargs) -> IdentityBulkCreateResponse

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

Bulk update records (partial success)

prism.objects.identities.bulk_update(IdentityBulkUpdateParams**kwargs) -> IdentityBulkUpdateResponse

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

Bulk delete records (partial success)

prism.objects.identities.bulk_delete(IdentityBulkDeleteParams**kwargs) -> IdentityBulkDeleteResponse

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

Duplicate object

prism.objects.identities.duplicate(stridentity_id, IdentityDuplicateParams**kwargs) -> IdentityDuplicateResponse

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

Restore object

prism.objects.identities.restore(stridentity_id, IdentityRestoreParams**kwargs) -> IdentityRestoreResponse

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

ModelsExpand Collapse

class Identity: …

default: Optional[Dict[str, object]]

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 IdentityCreateResponse: …

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 IdentityListResponse: …

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 IdentityGetResponse: …

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 IdentityUpdateResponse: …

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 IdentityQueryResponse: …

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 IdentityCountResponse: …

total: int

Number of records matching the access scope.

class IdentityFindResponse: …

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 IdentityUpsertResponse: …

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 IdentityBulkCreateResponse: …

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 IdentityBulkUpdateResponse: …

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 IdentityBulkDeleteResponse: …

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 IdentityDuplicateResponse: …

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 IdentityRestoreResponse: …

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]

ObjectsDeals

Create object

prism.objects.deals.create(DealCreateParams**kwargs) -> DealCreateResponse

POST/v2/prism/{teamId}/deal

List records of an object type

prism.objects.deals.list(DealListParams**kwargs) -> DealListResponse

GET/v2/prism/{teamId}/deal

Get object

prism.objects.deals.get(strdeal_id, DealGetParams**kwargs) -> DealGetResponse

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

Patch object

prism.objects.deals.update(strdeal_id, DealUpdateParams**kwargs) -> DealUpdateResponse

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

Delete object

prism.objects.deals.delete(strdeal_id, DealDeleteParams**kwargs)

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

Query

prism.objects.deals.query(DealQueryParams**kwargs) -> DealQueryResponse

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

Total record count for an object type

prism.objects.deals.count(DealCountParams**kwargs) -> DealCountResponse

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

Find a record by property value

prism.objects.deals.find(strvalue, DealFindParams**kwargs) -> DealFindResponse

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

Upsert by property value

prism.objects.deals.upsert(strvalue, DealUpsertParams**kwargs) -> DealUpsertResponse

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

Import objects

prism.objects.deals.bulk_create(DealBulkCreateParams**kwargs) -> DealBulkCreateResponse

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

Bulk update records (partial success)

prism.objects.deals.bulk_update(DealBulkUpdateParams**kwargs) -> DealBulkUpdateResponse

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

Bulk delete records (partial success)

prism.objects.deals.bulk_delete(DealBulkDeleteParams**kwargs) -> DealBulkDeleteResponse

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

Duplicate object

prism.objects.deals.duplicate(strdeal_id, DealDuplicateParams**kwargs) -> DealDuplicateResponse

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

Restore object

prism.objects.deals.restore(strdeal_id, DealRestoreParams**kwargs) -> DealRestoreResponse

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

ModelsExpand Collapse

class Deal: …

default: Optional[Dict[str, object]]

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 DealCreateResponse: …

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 DealListResponse: …

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 DealGetResponse: …

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 DealUpdateResponse: …

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 DealQueryResponse: …

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 DealCountResponse: …

total: int

Number of records matching the access scope.

class DealFindResponse: …

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 DealUpsertResponse: …

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 DealBulkCreateResponse: …

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 DealBulkUpdateResponse: …

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 DealBulkDeleteResponse: …

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 DealDuplicateResponse: …

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 DealRestoreResponse: …

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]

ObjectsDealsGrant

Get grant

prism.objects.deals.grant.get(strdeal_id, GrantGetParams**kwargs) -> GrantGetResponse

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

Update grant

prism.objects.deals.grant.update(strdeal_id, GrantUpdateParams**kwargs) -> GrantUpdateResponse

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

ModelsExpand Collapse

class GrantGetResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

class GrantUpdateResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

ObjectsActions

Create object

prism.objects.actions.create(ActionCreateParams**kwargs) -> ActionCreateResponse

POST/v2/prism/{teamId}/action

List records of an object type

prism.objects.actions.list(ActionListParams**kwargs) -> ActionListResponse

GET/v2/prism/{teamId}/action

Get object

prism.objects.actions.get(straction_id, ActionGetParams**kwargs) -> ActionGetResponse

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

Patch object

prism.objects.actions.update(straction_id, ActionUpdateParams**kwargs) -> ActionUpdateResponse

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

Delete object

prism.objects.actions.delete(straction_id, ActionDeleteParams**kwargs)

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

Query

prism.objects.actions.query(ActionQueryParams**kwargs) -> ActionQueryResponse

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

Total record count for an object type

prism.objects.actions.count(ActionCountParams**kwargs) -> ActionCountResponse

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

Find a record by property value

prism.objects.actions.find(strvalue, ActionFindParams**kwargs) -> ActionFindResponse

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

Upsert by property value

prism.objects.actions.upsert(strvalue, ActionUpsertParams**kwargs) -> ActionUpsertResponse

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

Import objects

prism.objects.actions.bulk_create(ActionBulkCreateParams**kwargs) -> ActionBulkCreateResponse

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

Bulk update records (partial success)

prism.objects.actions.bulk_update(ActionBulkUpdateParams**kwargs) -> ActionBulkUpdateResponse

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

Bulk delete records (partial success)

prism.objects.actions.bulk_delete(ActionBulkDeleteParams**kwargs) -> ActionBulkDeleteResponse

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

Duplicate object

prism.objects.actions.duplicate(straction_id, ActionDuplicateParams**kwargs) -> ActionDuplicateResponse

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

Restore object

prism.objects.actions.restore(straction_id, ActionRestoreParams**kwargs) -> ActionRestoreResponse

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

ModelsExpand Collapse

class Action: …

default: Optional[Dict[str, object]]

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 ActionCreateResponse: …

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 ActionListResponse: …

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 ActionGetResponse: …

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 ActionUpdateResponse: …

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 ActionQueryResponse: …

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 ActionCountResponse: …

total: int

Number of records matching the access scope.

class ActionFindResponse: …

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 ActionUpsertResponse: …

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 ActionBulkCreateResponse: …

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 ActionBulkUpdateResponse: …

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 ActionBulkDeleteResponse: …

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 ActionDuplicateResponse: …

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 ActionRestoreResponse: …

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]

ObjectsActionsGrant

Get grant

prism.objects.actions.grant.get(straction_id, GrantGetParams**kwargs) -> GrantGetResponse

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

Update grant

prism.objects.actions.grant.update(straction_id, GrantUpdateParams**kwargs) -> GrantUpdateResponse

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

ModelsExpand Collapse

class GrantGetResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

class GrantUpdateResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

ObjectsDocuments

Create object

prism.objects.documents.create(DocumentCreateParams**kwargs) -> DocumentCreateResponse

POST/v2/prism/{teamId}/document

List records of an object type

prism.objects.documents.list(DocumentListParams**kwargs) -> DocumentListResponse

GET/v2/prism/{teamId}/document

Get object

prism.objects.documents.get(strdocument_id, DocumentGetParams**kwargs) -> DocumentGetResponse

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

Patch object

prism.objects.documents.update(strdocument_id, DocumentUpdateParams**kwargs) -> DocumentUpdateResponse

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

Delete object

prism.objects.documents.delete(strdocument_id, DocumentDeleteParams**kwargs)

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

Query

prism.objects.documents.query(DocumentQueryParams**kwargs) -> DocumentQueryResponse

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

Total record count for an object type

prism.objects.documents.count(DocumentCountParams**kwargs) -> DocumentCountResponse

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

Find a record by property value

prism.objects.documents.find(strvalue, DocumentFindParams**kwargs) -> DocumentFindResponse

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

Upsert by property value

prism.objects.documents.upsert(strvalue, DocumentUpsertParams**kwargs) -> DocumentUpsertResponse

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

Import objects

prism.objects.documents.bulk_create(DocumentBulkCreateParams**kwargs) -> DocumentBulkCreateResponse

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

Bulk update records (partial success)

prism.objects.documents.bulk_update(DocumentBulkUpdateParams**kwargs) -> DocumentBulkUpdateResponse

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

Bulk delete records (partial success)

prism.objects.documents.bulk_delete(DocumentBulkDeleteParams**kwargs) -> DocumentBulkDeleteResponse

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

Duplicate object

prism.objects.documents.duplicate(strdocument_id, DocumentDuplicateParams**kwargs) -> DocumentDuplicateResponse

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

Restore object

prism.objects.documents.restore(strdocument_id, DocumentRestoreParams**kwargs) -> DocumentRestoreResponse

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

ModelsExpand Collapse

class Document: …

default: Optional[Dict[str, object]]

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 DocumentCreateResponse: …

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 DocumentListResponse: …

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 DocumentGetResponse: …

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 DocumentUpdateResponse: …

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 DocumentQueryResponse: …

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 DocumentCountResponse: …

total: int

Number of records matching the access scope.

class DocumentFindResponse: …

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 DocumentUpsertResponse: …

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 DocumentBulkCreateResponse: …

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 DocumentBulkUpdateResponse: …

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 DocumentBulkDeleteResponse: …

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 DocumentDuplicateResponse: …

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 DocumentRestoreResponse: …

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]

ObjectsDocumentsGrant

Get grant

prism.objects.documents.grant.get(strdocument_id, GrantGetParams**kwargs) -> GrantGetResponse

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

Update grant

prism.objects.documents.grant.update(strdocument_id, GrantUpdateParams**kwargs) -> GrantUpdateResponse

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

ModelsExpand Collapse

class GrantGetResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

class GrantUpdateResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

ObjectsEvents

List records of an object type

prism.objects.events.list(EventListParams**kwargs) -> EventListResponse

GET/v2/prism/{teamId}/event

Get object

prism.objects.events.get(strevent_id, EventGetParams**kwargs) -> EventGetResponse

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

Query

prism.objects.events.query(EventQueryParams**kwargs) -> EventQueryResponse

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

Total record count for an object type

prism.objects.events.count(EventCountParams**kwargs) -> EventCountResponse

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

Find a record by property value

prism.objects.events.find(strvalue, EventFindParams**kwargs) -> EventFindResponse

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

ModelsExpand Collapse

class Event: …

default: Optional[Dict[str, object]]

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 EventListResponse: …

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 EventGetResponse: …

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 EventQueryResponse: …

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 EventCountResponse: …

total: int

Number of records matching the access scope.

class EventFindResponse: …

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]

ObjectsEventsGrant

Get grant

prism.objects.events.grant.get(strevent_id, GrantGetParams**kwargs) -> GrantGetResponse

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

Update grant

prism.objects.events.grant.update(strevent_id, GrantUpdateParams**kwargs) -> GrantUpdateResponse

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

ModelsExpand Collapse

class GrantGetResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

class GrantUpdateResponse: …

team_group_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"

team_id: Optional[Dict[str, Literal["a", "r", "w"]]]

One of the following:

"a"

"r"

"w"

user_id: Optional[List[Dict[str, Literal["a", "r", "w"]]]]

One of the following:

"a"

"r"

"w"