This endpoint is used to get all engagements in an account.
Use case for this endpoint: Because engagements represent individual activity, you can use the endpoint to source the inputs for a machine learning model to help predict the best time for a call to a prospect or a customer.
In addition to the
contacts scope, the
sales-email-read scope is required to receive the details of any email-type engagements. See the Engagements API Overview for more details.
Returns a paginated set of engagements. Up to 250 records can be returned in a single response.
In addition to the list of engagements, each request will also return two values,
hasMore is true, you'll need to make another request, using the
offset to get the next page of engagement records.
This endpoint will not return engagements for sample contacts "Brian Halligan" or "Cool Robot."