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.
The number of records to return. Defaults to 100, has a maximum value of 250.
x <= 250
Used to page through the results. If there are more records in your portal than the limit= parameter, you will need to use the offset returned in the first request to get the next set of results.
Successful response - Paginated list of engagements
The response is of type object
.