Skip to main content
POST
/
action
/
hubspot.v2.get_engagements
Get HubSpot Engagements
curl --request POST \
  --url https://api-lr.agent.ai/v1/action/hubspot.v2.get_engagements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "object_type": "note",
  "source_object_id": "{{contact_id}}",
  "output_variable_name": "engagement_history",
  "engagement_types": [
    "notes",
    "calls",
    "emails",
    "meetings",
    "tasks"
  ],
  "properties": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "result_limit": "100"
}
'
{
  "status": 123,
  "response": {}
}

Authorizations

​
Authorization
string
header
required

Bearer token from your account (https://agent.ai/user/integrations#api)

Body

application/json
​
object_type
enum<string>
required
Available options:
note,
call,
email,
meeting,
task
​
source_object_id
string
default:{{contact_id}}
required

ID of the object to retrieve engagements for.

​
output_variable_name
string
default:engagement_history
required

Variable name to store the engagement history.

​
engagement_types
enum<string>[]

Select which types of engagements to retrieve.

Available options:
notes,
calls,
emails,
meetings,
tasks
​
properties
string

Select properties to retrieve from engagements

​
start_date
string

Optional date range to filter engagements (mm/dd/yyyy format).

​
end_date
string

Optional date range to filter engagements (mm/dd/yyyy format).

​
result_limit
string
default:100

Maximum number of engagements to return (default: 100, max: 500).

Response

Successful response

​
status
integer<int32>

HTTP status code of the action response

​
response
object

Response data from the action