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
| Method | Path | Description |
|---|---|---|
GET | /activity-types | List activity types |
GET | /activity-types/:id | Get an activity type |
POST | /activity-types | Create an activity type |
PATCH | /activity-types/:id | Update an activity type |
DELETE | /activity-types/:id | Delete 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
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
name | string | Display name. Required on create. |
color | string | null | Color, e.g. a hex code such as #8B5CF6. |
icon_key | string | null | Name of the icon shown in the app, e.g. map-pin. |
organization_id | integer | Organization that owns the type. Required on create. |
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 type is deleted. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.