Get all engagements

Last updated June 17, 2020

GET /engagements/v1/engagements/paged

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

contacts

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. 

Scopes

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.

Response 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, offset and hasMore. If 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."

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters How to use Description
Limit limit=
Used in the request URL
The number of records to return. Defaults to 100, has a maximum value of 250.
Offset offset=
Used in the request URL
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.