Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Engagement

Retrieves the collection of Engagement resources.

Retrieves the collection of Engagement resources.

get/engagements

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Engagement collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for each engagement

isActiveboolean nullable

Whether an engagement is active or not

createdstring

The date and time the engagement was created

modifiedstring nullable

The date and time the engagement was last modified

typestring nullable

The type of engagement e.g. "MEETING" e.g. "CALL"

contactIdsstring[] nullable

A list of IDs for associated contacts records

companyIdstring nullable

The ID of the associated company

dealIdsstring[] nullable

A list of IDs for associated deal records

Example response

[
  {
    "integration": "quickbooks"
  }
]