Get an engagement

This endpoint is used to get an engagement (a task or activity) for a CRM record in HubSpot. Use case for this endpoint: This data can be used to report on per-rep productivity or to integrate HubSpot with other back-office tools. For another example, you can use this information about an individual call to drive automation about when the next follow-up meeting or call should happen.

Scopes

In addition to the contacts scope, the sales-email-read scope is required in order to receive the details of any email-type engagements. See the Engagement API Overview for more details.

GET /engagements/v1/engagements/{engagementId}

Get an engagement

cURL

curl --request GET \
  --url https://api.hubapi.com/engagements/v1/engagements/{engagementId}

200

{
  "engagement": {
    "id": 123,
    "portalId": 123,
    "active": true,
    "createdAt": 123,
    "lastUpdated": 123,
    "ownerId": 123,
    "type": "EMAIL",
    "timestamp": 123
  },
  "associations": {
    "contactIds": [
      123
    ],
    "companyIds": [
      123
    ],
    "dealIds": [
      123
    ],
    "ownerIds": [
      123
    ]
  },
  "metadata": {}
}

Parâmetros de caminho

engagementId · string · obrigatório

The unique ID of the engagement you want the information for.

Resposta

200 - application/json

Successful response - Engagement information retrieved successfully

engagement · object

Show child attributes

associations · object

Show child attributes

metadata · object