Activities
Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person and an organization. Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes object) and can be assigned to a particular user. Note that activities can also be created without a specific date/time.
Get all activities assigned to a particular user
Returns all activities assigned to a particular user.
Cost
10
Request
/api/v2/activities
Query parameters
filter_id
integer
If supplied, only activities matching the specified filter are returned
ids
string
Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
owner_id
integer
If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
updated_since
string
If set, only activities with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
updated_until
string
If set, only activities with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
sort_by
string
The field to sort by. Supported fields: id, update_time, add_time.
Default
id
Values
id
update_time
add_time
sort_direction
string
The sorting direction. Supported values: asc, desc.
Default
asc
Values
asc
desc
include_fields
string
Optional comma separated string array of additional fields to include
Values
attendees
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
Response
OK
Expand all
Copy code- true
- [ ... ]▶
- { ... }▶
Get all activities (BETA)
Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions here.
Cost
10
Request
/v1/activities/collection
Query parameters
cursor
string
For pagination, the marker (an opaque string value) representing the first item on the next page
limit
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
since
string
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the update_time field.
until
string
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the update_time field.
user_id
integer
The ID of the user whose activities will be fetched. If omitted, all activities are returned.
done
boolean
Whether the activity is done or not. false = Not done, true = Done. If omitted, returns both done and not done activities.
type
string
The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the key_string parameter of ActivityTypes.
Response
OK
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
Get details of an activity
Returns the details of a specific activity.
Cost
1
Request
/api/v2/activities/{id}
Path parameters
id
integer
required
The ID of the activity
Query parameters
include_fields
string
Optional comma separated string array of additional fields to include
Values
attendees
Response
OK
Expand allCopy code- true
- { ... }▶
Add an activity
Adds a new activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for adding an activity.
Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync
Cost
5
Request
/api/v2/activities
Body parameters
application/json
subject
string
The subject of the activity
type
string
The type of the activity
owner_id
integer
The ID of the user who owns the activity
deal_id
integer
The ID of the deal linked to the activity
lead_id
string
The ID of the lead linked to the activity
person_id
integer
The ID of the person linked to the activity
org_id
integer
The ID of the organization linked to the activity
project_id
integer
The ID of the project linked to the activity
due_date
string
The due date of the activity
due_time
string
The due time of the activity
duration
string
The duration of the activity
busy
boolean
Whether the activity marks the assignee as busy or not in their calendar
done
boolean
Whether the activity is marked as done or not
location
object
Location of the activity
participants
array
The participants of the activity
attendees
array
The attendees of the activity
public_description
string
The public description of the activity
priority
integer
The priority of the activity. Mappable to a specific string using activityFields API.
note
string
The note of the activity
Response
OK
Expand allCopy code- true
- { ... }▶
Update an activity
Updates an activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).
Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync
Cost
5
Request
/api/v2/activities/{id}
Path parameters
id
integer
required
The ID of the activity
Body parameters
application/json
subject
string
The subject of the activity
type
string
The type of the activity
owner_id
integer
The ID of the user who owns the activity
deal_id
integer
The ID of the deal linked to the activity
lead_id
string
The ID of the lead linked to the activity
person_id
integer
The ID of the person linked to the activity
org_id
integer
The ID of the organization linked to the activity
project_id
integer
The ID of the project linked to the activity
due_date
string
The due date of the activity
due_time
string
The due time of the activity
duration
string
The duration of the activity
busy
boolean
Whether the activity marks the assignee as busy or not in their calendar
done
boolean
Whether the activity is marked as done or not
location
object
Location of the activity
participants
array
The participants of the activity
attendees
array
The attendees of the activity
public_description
string
The public description of the activity
priority
integer
The priority of the activity. Mappable to a specific string using activityFields API.
note
string
The note of the activity
Response
OK
Expand allCopy code- true
- { ... }▶
Delete multiple activities in bulk
Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
Cost
10
Request
/v1/activities
Query parameters
ids
string
required
The comma-separated IDs of activities that will be deleted
Response
OK
Expand allCopy code- true
- { ... }▶
Delete an activity
Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
Cost
3
Request
/api/v2/activities/{id}
Path parameters
id
integer
required
The ID of the activity
Response
OK
Expand allCopy code- true
- { ... }▶