This page provides a reference for all of the different objects that the Baack APIs return. These reference docs are intended to provide detailed information on the different representations sent by endpoints.
Postal or location address used by CRM and identity representation
Representation of an API client
Representation of a bearer token used to authenticate an API request
Representation of an OAuth token. These are typically granted during oauth flows and may include access and refresh tokens.
A boolean content item associatedwith a content entity
Representation of the history of a boolean (truthy) content item value
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.
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.
A page of companies
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.
Date time represented as ISO 8601 with milliseconds
Representation of a date / time timestamp (UTC) item value history
A double precision content item associated with a content entity
The history of values of a double item
Representation of an email address associated with an identity
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
Entity list item reference and sorting order
General API error object representation
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.
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.
Object representing an image resource
Representation of the history of an image content item
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
Representation of a JSON content entity for arbitrary JSON values
Representation of the history of a JSON item
A markdown item value associated with a particular entity
Representation of the markdown item history. Note that the history is ordered from newest to oldest and may be paginated.
Representation of a message thread which can be used for general chat or discussions associated with other concepts.
A money value item in the context of a content entity
Representation of a money content item history
Latitude / Longitude content item associated with an entity
Representation of the history of lat / long content item history
Representation of a long integer item
Representation of the history of a long integer content item. Note that history is returned from newest to oldest value
Representation of an organisation which holds multiple account related companies which own data regarding other companies in the platform etc.
Payment invoice identifier e.g. invoice ID
Representation of a payment invoice
Payment invoice line item
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 person associated with an identity
Name associated with a person (may be an alias)
Representation of a project which can be used to collect a set of tasks with workflows.
The recipient representation is used to model a payment invoice recipient either as a company or identity.
The remitter or payee is the company or identity which is making the payment in the context of a payment or invoice
Representation of a search and it's results when available
A search result item
A subject reference typically used in the context of a task activity log e.g. when a task is assigned the subject would be the assignee
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
Representation of a telephone number
Object representing a template content item associated with a content entity
Representation of the history of a template item values
A text content item associated with a content entity
Representation of the history of a text item including all of the revisions stored which may be paged if they exceed the maximum per response.
Representation of a post or message in a thread of messages
Representation of a session user returned in contexts like the API client context when user based authentication is being used
The webhook event representation is used for webhook message delivery acting like an envelope for the event.
Representation of the concept that a webhook trigger event relates to
Representation of a webhook subscription to listen for events supported by the given subject
Representation of a unique webhook trigger event
Workflow representation which holds a collection of stages
A single stage in a workflow