Activities
An activity is a task, call, meeting or other to-do on your calendar, optionally linked to a deal, contact or company and assigned to a user. When the assigned user has a connected Google or Outlook calendar that syncs the activity's type, the activity is also created on that calendar.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /activities | List activities |
GET | /activities/:id | Get an activity |
POST | /activities | Create an activity |
PATCH | /activities/:id | Update an activity |
DELETE | /activities/:id | Delete an activity |
Reads are limited to your API key's organization. Pass organization_id as a filter to work with one organization.
The activity object
json
company, assignedTo, createdBy, deal and contact are embedded on get, create and update responses, and on list when you pass fastJoinForActivityList=true.
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Organization that owns the activity. Required on create. |
created_by_user_id | integer | null | Read-only. User who created the activity (the API key's user). |
assigned_to_user_id | integer | null | User the activity is assigned to. Calendar sync and reminders use this user. |
subject | string | Title. Required on create. |
note | string | null | Internal notes. |
public_description | string | null | Description shown on the synced calendar event. |
location | string | null | Free-text location. |
location_geocoded | object | null | Any JSON describing the geocoded location. |
start_date | string (date) | Start date, YYYY-MM-DD. |
start_time | string | Start time. Send HH:MM (24 h); returned as HH:MM:SS. Times are in the organization's timezone. |
end_date | string (date) | End date, YYYY-MM-DD. |
end_time | string | End time. Send HH:MM (24 h); returned as HH:MM:SS. |
duration | number | Duration in minutes. |
deal_id | integer | null | Linked deal. |
contact_id | integer | null | Linked contact. |
company_id | integer | null | Linked company. |
activity_type | string | Type of activity. Default call. The built-in types are call, meeting, task, deadline, email and lunch; see also Activity types. |
done | boolean | Whether the activity is completed. Default false. |
attendees | array | null | People invited to the synced calendar event: { email, name, responseStatus }. email is required; responseStatus is one of needsAction, accepted, declined, tentative. |
create_google_meet | boolean | null | Set to true to add a Google Meet link to the synced Google Calendar event. |
google_meet_link | string | null | Read-only. Google Meet link of the synced event. |
synced_to_calendar | boolean | Read-only. Whether the activity is on the assignee's external calendar. Default false. |
sync_status | string | null | Read-only. pending, synced, failed or not_synced. |
last_synced_at | string (date-time) | null | Read-only. Last calendar sync time. |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the activity is deleted. |
Side effects
- Create and update sync the activity to the assignee's connected calendar when their calendar integration syncs this
activity_typeand the activity is notdone. Sync errors do not fail the request; they setsync_statustofailed. - When
assigned_to_user_id,start_dateandstart_timeare set and the start is in the future, the assignee gets a reminder 10 minutes before the start. - Create and update trigger the organization's activity automations.
Related
Report an issue with this documentation
Please log in to report issues with our documentation.