API Reference
Libraries
API Overview
Prism
PrismProperties
Get metadata properties by object type
GET/v2/prism/{teamId}/{objectType}/properties
Get metadata properties
GET/v2/prism/{teamId}/properties
Create a property definition
POST/v2/prism/{teamId}/{objectType}/properties
Update a property definition
PATCH/v2/prism/{teamId}/{objectType}/properties/{propertyId}
Delete a property definition
DELETE/v2/prism/{teamId}/{objectType}/properties/{propertyId}
PrismPropertiesOptions
Add an option to a select property
POST/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options
Update a property option
PATCH/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}
Delete a property option
DELETE/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}
PrismImports
Get the status of an import job
GET/v2/prism/{teamId}/imports/{jobId}
PrismObjects
PrismObjectsContacts
Create object
POST/v2/prism/{teamId}/contact
List records of an object type
GET/v2/prism/{teamId}/contact
Get object
GET/v2/prism/{teamId}/contact/{contactId}
Patch object
PATCH/v2/prism/{teamId}/contact/{contactId}
Delete object
DELETE/v2/prism/{teamId}/contact/{contactId}
Query
POST/v2/prism/{teamId}/contact/query
Total record count for an object type
GET/v2/prism/{teamId}/contact/count
Find a record by property value
GET/v2/prism/{teamId}/contact/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/contact/by/{slug}/{value}
Import objects
POST/v2/prism/{teamId}/contact/import
Bulk update records (partial success)
POST/v2/prism/{teamId}/contact/batch/update
Bulk delete records (partial success)
POST/v2/prism/{teamId}/contact/batch/delete
Duplicate object
POST/v2/prism/{teamId}/contact/{contactId}/duplicate
Restore object
POST/v2/prism/{teamId}/contact/{contactId}/restore
PrismObjectsOrganizations
Create object
POST/v2/prism/{teamId}/organization
List records of an object type
GET/v2/prism/{teamId}/organization
Get object
GET/v2/prism/{teamId}/organization/{organizationId}
Patch object
PATCH/v2/prism/{teamId}/organization/{organizationId}
Delete object
DELETE/v2/prism/{teamId}/organization/{organizationId}
Query
POST/v2/prism/{teamId}/organization/query
Total record count for an object type
GET/v2/prism/{teamId}/organization/count
Find a record by property value
GET/v2/prism/{teamId}/organization/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/organization/by/{slug}/{value}
Import objects
POST/v2/prism/{teamId}/organization/import
Bulk update records (partial success)
POST/v2/prism/{teamId}/organization/batch/update
Bulk delete records (partial success)
POST/v2/prism/{teamId}/organization/batch/delete
Duplicate object
POST/v2/prism/{teamId}/organization/{organizationId}/duplicate
Restore object
POST/v2/prism/{teamId}/organization/{organizationId}/restore
PrismObjectsIdentities
Create object
POST/v2/prism/{teamId}/identity
List records of an object type
GET/v2/prism/{teamId}/identity
Get object
GET/v2/prism/{teamId}/identity/{identityId}
Patch object
PATCH/v2/prism/{teamId}/identity/{identityId}
Delete object
DELETE/v2/prism/{teamId}/identity/{identityId}
Query
POST/v2/prism/{teamId}/identity/query
Total record count for an object type
GET/v2/prism/{teamId}/identity/count
Find a record by property value
GET/v2/prism/{teamId}/identity/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/identity/by/{slug}/{value}
Import objects
POST/v2/prism/{teamId}/identity/import
Bulk update records (partial success)
POST/v2/prism/{teamId}/identity/batch/update
Bulk delete records (partial success)
POST/v2/prism/{teamId}/identity/batch/delete
Duplicate object
POST/v2/prism/{teamId}/identity/{identityId}/duplicate
Restore object
POST/v2/prism/{teamId}/identity/{identityId}/restore
PrismObjectsDeals
Create object
POST/v2/prism/{teamId}/deal
List records of an object type
GET/v2/prism/{teamId}/deal
Get object
GET/v2/prism/{teamId}/deal/{dealId}
Patch object
PATCH/v2/prism/{teamId}/deal/{dealId}
Delete object
DELETE/v2/prism/{teamId}/deal/{dealId}
Query
POST/v2/prism/{teamId}/deal/query
Total record count for an object type
GET/v2/prism/{teamId}/deal/count
Find a record by property value
GET/v2/prism/{teamId}/deal/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/deal/by/{slug}/{value}
Import objects
POST/v2/prism/{teamId}/deal/import
Bulk update records (partial success)
POST/v2/prism/{teamId}/deal/batch/update
Bulk delete records (partial success)
POST/v2/prism/{teamId}/deal/batch/delete
Duplicate object
POST/v2/prism/{teamId}/deal/{dealId}/duplicate
Restore object
POST/v2/prism/{teamId}/deal/{dealId}/restore
PrismObjectsDealsGrant
Get grant
GET/v2/prism/{teamId}/deal/{dealId}/grant
Update grant
PUT/v2/prism/{teamId}/deal/{dealId}/grant
PrismObjectsActions
Create object
POST/v2/prism/{teamId}/action
List records of an object type
GET/v2/prism/{teamId}/action
Get object
GET/v2/prism/{teamId}/action/{actionId}
Patch object
PATCH/v2/prism/{teamId}/action/{actionId}
Delete object
DELETE/v2/prism/{teamId}/action/{actionId}
Query
POST/v2/prism/{teamId}/action/query
Total record count for an object type
GET/v2/prism/{teamId}/action/count
Find a record by property value
GET/v2/prism/{teamId}/action/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/action/by/{slug}/{value}
Import objects
POST/v2/prism/{teamId}/action/import
Bulk update records (partial success)
POST/v2/prism/{teamId}/action/batch/update
Bulk delete records (partial success)
POST/v2/prism/{teamId}/action/batch/delete
Duplicate object
POST/v2/prism/{teamId}/action/{actionId}/duplicate
Restore object
POST/v2/prism/{teamId}/action/{actionId}/restore
PrismObjectsActionsGrant
Get grant
GET/v2/prism/{teamId}/action/{actionId}/grant
Update grant
PUT/v2/prism/{teamId}/action/{actionId}/grant
PrismObjectsDocuments
Create object
POST/v2/prism/{teamId}/document
List records of an object type
GET/v2/prism/{teamId}/document
Get object
GET/v2/prism/{teamId}/document/{documentId}
Patch object
PATCH/v2/prism/{teamId}/document/{documentId}
Delete object
DELETE/v2/prism/{teamId}/document/{documentId}
Query
POST/v2/prism/{teamId}/document/query
Total record count for an object type
GET/v2/prism/{teamId}/document/count
Find a record by property value
GET/v2/prism/{teamId}/document/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/document/by/{slug}/{value}
Import objects
POST/v2/prism/{teamId}/document/import
Bulk update records (partial success)
POST/v2/prism/{teamId}/document/batch/update
Bulk delete records (partial success)
POST/v2/prism/{teamId}/document/batch/delete
Duplicate object
POST/v2/prism/{teamId}/document/{documentId}/duplicate
Restore object
POST/v2/prism/{teamId}/document/{documentId}/restore
PrismObjectsDocumentsGrant
Get grant
GET/v2/prism/{teamId}/document/{documentId}/grant
Update grant
PUT/v2/prism/{teamId}/document/{documentId}/grant
PrismObjectsEvents
Create object
POST/v2/prism/{teamId}/event
List records of an object type
GET/v2/prism/{teamId}/event
Get object
GET/v2/prism/{teamId}/event/{eventId}
Patch object
PATCH/v2/prism/{teamId}/event/{eventId}
Delete object
DELETE/v2/prism/{teamId}/event/{eventId}
Query
POST/v2/prism/{teamId}/event/query
Total record count for an object type
GET/v2/prism/{teamId}/event/count
Find a record by property value
GET/v2/prism/{teamId}/event/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/event/by/{slug}/{value}
Duplicate object
POST/v2/prism/{teamId}/event/{eventId}/duplicate
Restore object
POST/v2/prism/{teamId}/event/{eventId}/restore
PrismObjectsEventsGrant
Get grant
GET/v2/prism/{teamId}/event/{eventId}/grant
Update grant
PUT/v2/prism/{teamId}/event/{eventId}/grant
PrismObjectsEngagements
Create object
POST/v2/prism/{teamId}/engagement
List records of an object type
GET/v2/prism/{teamId}/engagement
Get object
GET/v2/prism/{teamId}/engagement/{engagementId}
Patch object
PATCH/v2/prism/{teamId}/engagement/{engagementId}
Delete object
DELETE/v2/prism/{teamId}/engagement/{engagementId}
Query
POST/v2/prism/{teamId}/engagement/query
Total record count for an object type
GET/v2/prism/{teamId}/engagement/count
Find a record by property value
GET/v2/prism/{teamId}/engagement/by/{slug}/{value}
Upsert by property value
PUT/v2/prism/{teamId}/engagement/by/{slug}/{value}
Import objects
POST/v2/prism/{teamId}/engagement/import
Bulk update records (partial success)
POST/v2/prism/{teamId}/engagement/batch/update
Bulk delete records (partial success)
POST/v2/prism/{teamId}/engagement/batch/delete
Duplicate object
POST/v2/prism/{teamId}/engagement/{engagementId}/duplicate
Restore object
POST/v2/prism/{teamId}/engagement/{engagementId}/restore
PrismObjectsEngagementsGrant
Get grant
GET/v2/prism/{teamId}/engagement/{engagementId}/grant
Update grant
PUT/v2/prism/{teamId}/engagement/{engagementId}/grant
Views
Create a view bundle (view + select/filter/sort)
POST/v2/prism/{teamId}/{objectType}/views
List saved views for an owner
GET/v2/prism/{teamId}/{objectType}/views
Read a view bundle
GET/v2/prism/{teamId}/{objectType}/views/{viewId}
Update a view bundle (select/filter/sort arrays are replaced wholesale when supplied)
PATCH/v2/prism/{teamId}/{objectType}/views/{viewId}
Delete a view bundle
DELETE/v2/prism/{teamId}/{objectType}/views/{viewId}
ViewsRecords
List records selected by a view (filters and sorts applied; pinned record_order overlaid first)
GET/v2/prism/{teamId}/{objectType}/views/{viewId}/records
Bulk reorder pinned records
PATCH/v2/prism/{teamId}/{objectType}/views/{viewId}/records
Pin a record to the view (append to record_order)
POST/v2/prism/{teamId}/{objectType}/views/{viewId}/records/{objectId}
Unpin a record from the view
DELETE/v2/prism/{teamId}/{objectType}/views/{viewId}/records/{objectId}
Triggered Automations
Create a triggered automation (state + changeset filter trees)
POST/v2/prism/{teamId}/{automationObjectType}/triggered_automations
List triggered automations for an owner
GET/v2/prism/{teamId}/{automationObjectType}/triggered_automations
Read a triggered automation
GET/v2/prism/{teamId}/{automationObjectType}/triggered_automations/{automationId}
Replace a triggered automation (idempotent full write of the whole tree)
PUT/v2/prism/{teamId}/{automationObjectType}/triggered_automations/{automationId}
Delete a triggered automation and its filter trees
DELETE/v2/prism/{teamId}/{automationObjectType}/triggered_automations/{automationId}
Webhooks
List webhooks
GET/v2/webhooks/{teamId}
Create a webhook
POST/v2/webhooks/{teamId}
Get a webhook
GET/v2/webhooks/{teamId}/{webhookId}
Update a webhook
PATCH/v2/webhooks/{teamId}/{webhookId}
Delete a webhook
DELETE/v2/webhooks/{teamId}/{webhookId}
Re-run verification
POST/v2/webhooks/{teamId}/{webhookId}/verify
Send a test event
POST/v2/webhooks/{teamId}/{webhookId}/ping
List team deliveries
GET/v2/webhooks/{teamId}/deliveries
WebhooksDeliveries
List webhook deliveries
GET/v2/webhooks/{teamId}/{webhookId}/deliveries
Get a delivery
GET/v2/webhooks/{teamId}/{webhookId}/deliveries/{deliveryId}
Realtime
Create a realtime streaming ticket
POST/v2/realtime/ticket