Skip to content
Micro micro
Go to Micro
API Reference
Prism

Objects

ObjectsContacts

Create object
client.Prism.Objects.Contacts.New(ctx, params) (*PrismObjectContactNewResponse, error)
POST/v2/prism/{teamId}/contact
List records of an object type
client.Prism.Objects.Contacts.List(ctx, params) (*PrismObjectContactListResponse, error)
GET/v2/prism/{teamId}/contact
Get object
client.Prism.Objects.Contacts.Get(ctx, contactID, params) (*PrismObjectContactGetResponse, error)
GET/v2/prism/{teamId}/contact/{contactId}
Patch object
client.Prism.Objects.Contacts.Update(ctx, contactID, params) (*PrismObjectContactUpdateResponse, error)
PATCH/v2/prism/{teamId}/contact/{contactId}
Delete object
client.Prism.Objects.Contacts.Delete(ctx, contactID, params) error
DELETE/v2/prism/{teamId}/contact/{contactId}
Query
client.Prism.Objects.Contacts.Query(ctx, params) (*PrismObjectContactQueryResponse, error)
POST/v2/prism/{teamId}/contact/query
Total record count for an object type
client.Prism.Objects.Contacts.Count(ctx, params) (*PrismObjectContactCountResponse, error)
GET/v2/prism/{teamId}/contact/count
Find a record by property value
client.Prism.Objects.Contacts.Find(ctx, slug, value, params) (*PrismObjectContactFindResponse, error)
GET/v2/prism/{teamId}/contact/by/{slug}/{value}
Upsert by property value
client.Prism.Objects.Contacts.Upsert(ctx, slug, value, params) (*PrismObjectContactUpsertResponse, error)
PUT/v2/prism/{teamId}/contact/by/{slug}/{value}
Import objects
client.Prism.Objects.Contacts.BulkNew(ctx, params) (*PrismObjectContactBulkNewResponse, error)
POST/v2/prism/{teamId}/contact/import
Bulk update records (partial success)
client.Prism.Objects.Contacts.BulkUpdate(ctx, params) (*PrismObjectContactBulkUpdateResponse, error)
POST/v2/prism/{teamId}/contact/batch/update
Bulk delete records (partial success)
client.Prism.Objects.Contacts.BulkDelete(ctx, params) (*PrismObjectContactBulkDeleteResponse, error)
POST/v2/prism/{teamId}/contact/batch/delete
Duplicate object
client.Prism.Objects.Contacts.Duplicate(ctx, contactID, params) (*PrismObjectContactDuplicateResponse, error)
POST/v2/prism/{teamId}/contact/{contactId}/duplicate
Restore object
client.Prism.Objects.Contacts.Restore(ctx, contactID, params) (*PrismObjectContactRestoreResponse, error)
POST/v2/prism/{teamId}/contact/{contactId}/restore
ModelsExpand Collapse
type Contact struct{…}
Default map[string, unknown]Optional

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 unknownOptional

ObjectsOrganizations

Create object
client.Prism.Objects.Organizations.New(ctx, params) (*PrismObjectOrganizationNewResponse, error)
POST/v2/prism/{teamId}/organization
List records of an object type
client.Prism.Objects.Organizations.List(ctx, params) (*PrismObjectOrganizationListResponse, error)
GET/v2/prism/{teamId}/organization
Get object
client.Prism.Objects.Organizations.Get(ctx, organizationID, params) (*PrismObjectOrganizationGetResponse, error)
GET/v2/prism/{teamId}/organization/{organizationId}
Patch object
client.Prism.Objects.Organizations.Update(ctx, organizationID, params) (*PrismObjectOrganizationUpdateResponse, error)
PATCH/v2/prism/{teamId}/organization/{organizationId}
Delete object
client.Prism.Objects.Organizations.Delete(ctx, organizationID, params) error
DELETE/v2/prism/{teamId}/organization/{organizationId}
Query
client.Prism.Objects.Organizations.Query(ctx, params) (*PrismObjectOrganizationQueryResponse, error)
POST/v2/prism/{teamId}/organization/query
Total record count for an object type
client.Prism.Objects.Organizations.Count(ctx, params) (*PrismObjectOrganizationCountResponse, error)
GET/v2/prism/{teamId}/organization/count
Find a record by property value
client.Prism.Objects.Organizations.Find(ctx, slug, value, params) (*PrismObjectOrganizationFindResponse, error)
GET/v2/prism/{teamId}/organization/by/{slug}/{value}
Upsert by property value
client.Prism.Objects.Organizations.Upsert(ctx, slug, value, params) (*PrismObjectOrganizationUpsertResponse, error)
PUT/v2/prism/{teamId}/organization/by/{slug}/{value}
Import objects
client.Prism.Objects.Organizations.BulkNew(ctx, params) (*PrismObjectOrganizationBulkNewResponse, error)
POST/v2/prism/{teamId}/organization/import
Bulk update records (partial success)
client.Prism.Objects.Organizations.BulkUpdate(ctx, params) (*PrismObjectOrganizationBulkUpdateResponse, error)
POST/v2/prism/{teamId}/organization/batch/update
Bulk delete records (partial success)
client.Prism.Objects.Organizations.BulkDelete(ctx, params) (*PrismObjectOrganizationBulkDeleteResponse, error)
POST/v2/prism/{teamId}/organization/batch/delete
Duplicate object
client.Prism.Objects.Organizations.Duplicate(ctx, organizationID, params) (*PrismObjectOrganizationDuplicateResponse, error)
POST/v2/prism/{teamId}/organization/{organizationId}/duplicate
Restore object
client.Prism.Objects.Organizations.Restore(ctx, organizationID, params) (*PrismObjectOrganizationRestoreResponse, error)
POST/v2/prism/{teamId}/organization/{organizationId}/restore
ModelsExpand Collapse
type Organization struct{…}
Default map[string, unknown]Optional

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 unknownOptional

ObjectsIdentities

Create object
client.Prism.Objects.Identities.New(ctx, params) (*PrismObjectIdentityNewResponse, error)
POST/v2/prism/{teamId}/identity
List records of an object type
client.Prism.Objects.Identities.List(ctx, params) (*PrismObjectIdentityListResponse, error)
GET/v2/prism/{teamId}/identity
Get object
client.Prism.Objects.Identities.Get(ctx, identityID, params) (*PrismObjectIdentityGetResponse, error)
GET/v2/prism/{teamId}/identity/{identityId}
Patch object
client.Prism.Objects.Identities.Update(ctx, identityID, params) (*PrismObjectIdentityUpdateResponse, error)
PATCH/v2/prism/{teamId}/identity/{identityId}
Delete object
client.Prism.Objects.Identities.Delete(ctx, identityID, params) error
DELETE/v2/prism/{teamId}/identity/{identityId}
Query
client.Prism.Objects.Identities.Query(ctx, params) (*PrismObjectIdentityQueryResponse, error)
POST/v2/prism/{teamId}/identity/query
Total record count for an object type
client.Prism.Objects.Identities.Count(ctx, params) (*PrismObjectIdentityCountResponse, error)
GET/v2/prism/{teamId}/identity/count
Find a record by property value
client.Prism.Objects.Identities.Find(ctx, slug, value, params) (*PrismObjectIdentityFindResponse, error)
GET/v2/prism/{teamId}/identity/by/{slug}/{value}
Upsert by property value
client.Prism.Objects.Identities.Upsert(ctx, slug, value, params) (*PrismObjectIdentityUpsertResponse, error)
PUT/v2/prism/{teamId}/identity/by/{slug}/{value}
Import objects
client.Prism.Objects.Identities.BulkNew(ctx, params) (*PrismObjectIdentityBulkNewResponse, error)
POST/v2/prism/{teamId}/identity/import
Bulk update records (partial success)
client.Prism.Objects.Identities.BulkUpdate(ctx, params) (*PrismObjectIdentityBulkUpdateResponse, error)
POST/v2/prism/{teamId}/identity/batch/update
Bulk delete records (partial success)
client.Prism.Objects.Identities.BulkDelete(ctx, params) (*PrismObjectIdentityBulkDeleteResponse, error)
POST/v2/prism/{teamId}/identity/batch/delete
Duplicate object
client.Prism.Objects.Identities.Duplicate(ctx, identityID, params) (*PrismObjectIdentityDuplicateResponse, error)
POST/v2/prism/{teamId}/identity/{identityId}/duplicate
Restore object
client.Prism.Objects.Identities.Restore(ctx, identityID, params) (*PrismObjectIdentityRestoreResponse, error)
POST/v2/prism/{teamId}/identity/{identityId}/restore
ModelsExpand Collapse
type Identity struct{…}
Default map[string, unknown]Optional

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 unknownOptional

ObjectsDeals

Create object
client.Prism.Objects.Deals.New(ctx, params) (*PrismObjectDealNewResponse, error)
POST/v2/prism/{teamId}/deal
List records of an object type
client.Prism.Objects.Deals.List(ctx, params) (*PrismObjectDealListResponse, error)
GET/v2/prism/{teamId}/deal
Get object
client.Prism.Objects.Deals.Get(ctx, dealID, params) (*PrismObjectDealGetResponse, error)
GET/v2/prism/{teamId}/deal/{dealId}
Patch object
client.Prism.Objects.Deals.Update(ctx, dealID, params) (*PrismObjectDealUpdateResponse, error)
PATCH/v2/prism/{teamId}/deal/{dealId}
Delete object
client.Prism.Objects.Deals.Delete(ctx, dealID, params) error
DELETE/v2/prism/{teamId}/deal/{dealId}
Query
client.Prism.Objects.Deals.Query(ctx, params) (*PrismObjectDealQueryResponse, error)
POST/v2/prism/{teamId}/deal/query
Total record count for an object type
client.Prism.Objects.Deals.Count(ctx, params) (*PrismObjectDealCountResponse, error)
GET/v2/prism/{teamId}/deal/count
Find a record by property value
client.Prism.Objects.Deals.Find(ctx, slug, value, params) (*PrismObjectDealFindResponse, error)
GET/v2/prism/{teamId}/deal/by/{slug}/{value}
Upsert by property value
client.Prism.Objects.Deals.Upsert(ctx, slug, value, params) (*PrismObjectDealUpsertResponse, error)
PUT/v2/prism/{teamId}/deal/by/{slug}/{value}
Import objects
client.Prism.Objects.Deals.BulkNew(ctx, params) (*PrismObjectDealBulkNewResponse, error)
POST/v2/prism/{teamId}/deal/import
Bulk update records (partial success)
client.Prism.Objects.Deals.BulkUpdate(ctx, params) (*PrismObjectDealBulkUpdateResponse, error)
POST/v2/prism/{teamId}/deal/batch/update
Bulk delete records (partial success)
client.Prism.Objects.Deals.BulkDelete(ctx, params) (*PrismObjectDealBulkDeleteResponse, error)
POST/v2/prism/{teamId}/deal/batch/delete
Duplicate object
client.Prism.Objects.Deals.Duplicate(ctx, dealID, params) (*PrismObjectDealDuplicateResponse, error)
POST/v2/prism/{teamId}/deal/{dealId}/duplicate
Restore object
client.Prism.Objects.Deals.Restore(ctx, dealID, params) (*PrismObjectDealRestoreResponse, error)
POST/v2/prism/{teamId}/deal/{dealId}/restore
ModelsExpand Collapse
type Deal struct{…}
Default map[string, unknown]Optional

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 unknownOptional

ObjectsDealsGrant

Get grant
client.Prism.Objects.Deals.Grant.Get(ctx, dealID, query) (*PrismObjectDealGrantGetResponse, error)
GET/v2/prism/{teamId}/deal/{dealId}/grant
Update grant
client.Prism.Objects.Deals.Grant.Update(ctx, dealID, params) (*PrismObjectDealGrantUpdateResponse, error)
PUT/v2/prism/{teamId}/deal/{dealId}/grant

ObjectsActions

Create object
client.Prism.Objects.Actions.New(ctx, params) (*PrismObjectActionNewResponse, error)
POST/v2/prism/{teamId}/action
List records of an object type
client.Prism.Objects.Actions.List(ctx, params) (*PrismObjectActionListResponse, error)
GET/v2/prism/{teamId}/action
Get object
client.Prism.Objects.Actions.Get(ctx, actionID, params) (*PrismObjectActionGetResponse, error)
GET/v2/prism/{teamId}/action/{actionId}
Patch object
client.Prism.Objects.Actions.Update(ctx, actionID, params) (*PrismObjectActionUpdateResponse, error)
PATCH/v2/prism/{teamId}/action/{actionId}
Delete object
client.Prism.Objects.Actions.Delete(ctx, actionID, params) error
DELETE/v2/prism/{teamId}/action/{actionId}
Query
client.Prism.Objects.Actions.Query(ctx, params) (*PrismObjectActionQueryResponse, error)
POST/v2/prism/{teamId}/action/query
Total record count for an object type
client.Prism.Objects.Actions.Count(ctx, params) (*PrismObjectActionCountResponse, error)
GET/v2/prism/{teamId}/action/count
Find a record by property value
client.Prism.Objects.Actions.Find(ctx, slug, value, params) (*PrismObjectActionFindResponse, error)
GET/v2/prism/{teamId}/action/by/{slug}/{value}
Upsert by property value
client.Prism.Objects.Actions.Upsert(ctx, slug, value, params) (*PrismObjectActionUpsertResponse, error)
PUT/v2/prism/{teamId}/action/by/{slug}/{value}
Import objects
client.Prism.Objects.Actions.BulkNew(ctx, params) (*PrismObjectActionBulkNewResponse, error)
POST/v2/prism/{teamId}/action/import
Bulk update records (partial success)
client.Prism.Objects.Actions.BulkUpdate(ctx, params) (*PrismObjectActionBulkUpdateResponse, error)
POST/v2/prism/{teamId}/action/batch/update
Bulk delete records (partial success)
client.Prism.Objects.Actions.BulkDelete(ctx, params) (*PrismObjectActionBulkDeleteResponse, error)
POST/v2/prism/{teamId}/action/batch/delete
Duplicate object
client.Prism.Objects.Actions.Duplicate(ctx, actionID, params) (*PrismObjectActionDuplicateResponse, error)
POST/v2/prism/{teamId}/action/{actionId}/duplicate
Restore object
client.Prism.Objects.Actions.Restore(ctx, actionID, params) (*PrismObjectActionRestoreResponse, error)
POST/v2/prism/{teamId}/action/{actionId}/restore
ModelsExpand Collapse
type Action struct{…}
Default map[string, unknown]Optional

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 unknownOptional

ObjectsActionsGrant

Get grant
client.Prism.Objects.Actions.Grant.Get(ctx, actionID, query) (*PrismObjectActionGrantGetResponse, error)
GET/v2/prism/{teamId}/action/{actionId}/grant
Update grant
client.Prism.Objects.Actions.Grant.Update(ctx, actionID, params) (*PrismObjectActionGrantUpdateResponse, error)
PUT/v2/prism/{teamId}/action/{actionId}/grant

ObjectsDocuments

Create object
client.Prism.Objects.Documents.New(ctx, params) (*PrismObjectDocumentNewResponse, error)
POST/v2/prism/{teamId}/document
List records of an object type
client.Prism.Objects.Documents.List(ctx, params) (*PrismObjectDocumentListResponse, error)
GET/v2/prism/{teamId}/document
Get object
client.Prism.Objects.Documents.Get(ctx, documentID, params) (*PrismObjectDocumentGetResponse, error)
GET/v2/prism/{teamId}/document/{documentId}
Patch object
client.Prism.Objects.Documents.Update(ctx, documentID, params) (*PrismObjectDocumentUpdateResponse, error)
PATCH/v2/prism/{teamId}/document/{documentId}
Delete object
client.Prism.Objects.Documents.Delete(ctx, documentID, params) error
DELETE/v2/prism/{teamId}/document/{documentId}
Query
client.Prism.Objects.Documents.Query(ctx, params) (*PrismObjectDocumentQueryResponse, error)
POST/v2/prism/{teamId}/document/query
Total record count for an object type
client.Prism.Objects.Documents.Count(ctx, params) (*PrismObjectDocumentCountResponse, error)
GET/v2/prism/{teamId}/document/count
Find a record by property value
client.Prism.Objects.Documents.Find(ctx, slug, value, params) (*PrismObjectDocumentFindResponse, error)
GET/v2/prism/{teamId}/document/by/{slug}/{value}
Upsert by property value
client.Prism.Objects.Documents.Upsert(ctx, slug, value, params) (*PrismObjectDocumentUpsertResponse, error)
PUT/v2/prism/{teamId}/document/by/{slug}/{value}
Import objects
client.Prism.Objects.Documents.BulkNew(ctx, params) (*PrismObjectDocumentBulkNewResponse, error)
POST/v2/prism/{teamId}/document/import
Bulk update records (partial success)
client.Prism.Objects.Documents.BulkUpdate(ctx, params) (*PrismObjectDocumentBulkUpdateResponse, error)
POST/v2/prism/{teamId}/document/batch/update
Bulk delete records (partial success)
client.Prism.Objects.Documents.BulkDelete(ctx, params) (*PrismObjectDocumentBulkDeleteResponse, error)
POST/v2/prism/{teamId}/document/batch/delete
Duplicate object
client.Prism.Objects.Documents.Duplicate(ctx, documentID, params) (*PrismObjectDocumentDuplicateResponse, error)
POST/v2/prism/{teamId}/document/{documentId}/duplicate
Restore object
client.Prism.Objects.Documents.Restore(ctx, documentID, params) (*PrismObjectDocumentRestoreResponse, error)
POST/v2/prism/{teamId}/document/{documentId}/restore
ModelsExpand Collapse
type Document struct{…}
Default map[string, unknown]Optional

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 unknownOptional

ObjectsDocumentsGrant

Get grant
client.Prism.Objects.Documents.Grant.Get(ctx, documentID, query) (*PrismObjectDocumentGrantGetResponse, error)
GET/v2/prism/{teamId}/document/{documentId}/grant
Update grant
client.Prism.Objects.Documents.Grant.Update(ctx, documentID, params) (*PrismObjectDocumentGrantUpdateResponse, error)
PUT/v2/prism/{teamId}/document/{documentId}/grant

ObjectsEvents

List records of an object type
client.Prism.Objects.Events.List(ctx, params) (*PrismObjectEventListResponse, error)
GET/v2/prism/{teamId}/event
Get object
client.Prism.Objects.Events.Get(ctx, eventID, params) (*PrismObjectEventGetResponse, error)
GET/v2/prism/{teamId}/event/{eventId}
Query
client.Prism.Objects.Events.Query(ctx, params) (*PrismObjectEventQueryResponse, error)
POST/v2/prism/{teamId}/event/query
Total record count for an object type
client.Prism.Objects.Events.Count(ctx, params) (*PrismObjectEventCountResponse, error)
GET/v2/prism/{teamId}/event/count
Find a record by property value
client.Prism.Objects.Events.Find(ctx, slug, value, params) (*PrismObjectEventFindResponse, error)
GET/v2/prism/{teamId}/event/by/{slug}/{value}
ModelsExpand Collapse
type Event struct{…}
Default map[string, unknown]Optional

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 unknownOptional

ObjectsEventsGrant

Get grant
client.Prism.Objects.Events.Grant.Get(ctx, eventID, query) (*PrismObjectEventGrantGetResponse, error)
GET/v2/prism/{teamId}/event/{eventId}/grant
Update grant
client.Prism.Objects.Events.Grant.Update(ctx, eventID, params) (*PrismObjectEventGrantUpdateResponse, error)
PUT/v2/prism/{teamId}/event/{eventId}/grant