API reference

The typed values that make up a content entity: text, markdown, numbers, money, images and more, each with its history.

A content entity, similar to a page with a collection of content items of differing types

Entity list for a collection of entity references. Note that the returned entity list on read will respect the natural ordering of the entity order sort order field

Image files are transferred using multipipart/form-data which is widely supported by HTTP clients and browsers to submit files. The endpoint allows upload of a single 'src' file which will be associated with either the default, large or medium format file according to the value of the imageItemFormat

Postal or location address used by CRM and identity representation

Client identifiers are associated with identities and are typically used to uniquely identify a particular identity in the scope of a particular domain e.g. Google SignIn profile ID or other platform user identifier.

Representation of a company object which may have a parent company (in structured companies), an owner, if this company represents some CRM company owned by a customer company and an organisation for which this company and associated accounts are provisioned.

A page of companies

Representation of an email address associated with an identity

Identity encapsulates all information associated with a person's identity like their contact details, associated addresses etc. The identity representation is used in multiple contexts and use cases like the identity of people in CRM as well as in the context of other use cases like role based access control or group membership.

Representation of an organisation which holds multiple account related companies which own data regarding other companies in the platform etc.

Representation of a person associated with an identity

Name associated with a person (may be an alias)

Representation of a telephone number

Representation of a project which can be used to collect a set of tasks with workflows.

Representation of a task with references to associated concepts as well as baseline fields for managing tasks

Representation of a single task log entry related to a tasks history of activities

Workflow representation which holds a collection of stages

A group of identities (people) which can be used for various purposes like permissions or collections of identities like a mailing list or a community

Representation of a group membership configuration. Note that the presence of a membership does not imply that the membership is active. Review the state for details of the current state. To support opt out and other negative preferences the state includes options for opt out of a group either by the member or the owner.

Representation of the 'inbox' of message threads with notification most recent updated and timestamp

Representation of a message thread which can be used for general chat or discussions associated with other concepts.

Representation of a notification of unread messages on a message thread. These are automatically updated for members with a subscription to in app updates when a thread post is created. They can also be created via the API to allow integrations to model an inbox of notifications for identities on their integration

Representation of a post or message in a thread of messages

Representation of a payment invoice

Representation of an API client

Representation of a bearer token used to authenticate an API request

Representation of the client context metadata to allow callers to understand the current client session state. The client context may be using a regular web session (in the case of your client accessing content via a logged in user session), a bearer token either from a secure server to server context or a bearer token from an insecure browser client. The response JSON will let you understand your session state in order to trigger experiences like logging in a user to allow them to use client features like the Editor or Tasks clients.

Representation of an OAuth token. These are typically granted during oauth flows and may include access and refresh tokens.

Representation of a permission grant. Permissions are fail closed so if an object requires a permission it must be present for the subject with the given label.Permissions represent directed edges granting a subject(type) [label] to object(type). When applied to an object the permissions will be checked for an exists style relationship from the subject scope.

A role in role based access control context which can be associated with various actors

Representation of a search and it's results when available

Representation of a webhook subscription to listen for events supported by the given subject

Representation of a unique webhook trigger event

Types shared by several representations, such as pagination, and types used outside a single resource.