Get all engagements

Last updated August 21, 2019

GET /engagements/v1/engagements/paged

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Required Scope:


Get all of the engagements in a portal.  Returns a paginated set of engagements.

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.