Activity types

Activity types are the custom categories (with a color and icon) your organization defines for activities, on top of the built-in ones.

Endpoints

MethodPathDescription
GET/activity-typesList activity types
GET/activity-types/:idGet an activity type
POST/activity-typesCreate an activity type
PATCH/activity-types/:idUpdate an activity type
DELETE/activity-types/:idDelete an activity type

Reads are limited to your API key's organization. Pass organization_id as a filter to work with one organization.

The activity type object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
namestringDisplay name. Required on create.
colorstring | nullColor, e.g. a hex code such as #8B5CF6.
icon_keystring | nullName of the icon shown in the app, e.g. map-pin.
organization_idintegerOrganization that owns the type. Required on create.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the type is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.