v1

latestOpenAPI 3.1.02026-07-24112760.5 KB
Activity Types

Get all activity types

Retrieve all activity types within the organization.

get/api/v1/activity_types

Query parameters

includestring

Which fields to include in the response

Which fields to include in the response

eagerboolean nullable

Whether to eager load joins

Whether to eager load joins

Response

Returns a list of activity types.

ahtnumber nullable

Average handle time of the activity in seconds

archivedboolean nullable
client_idinteger nullable

ID of the client that this activity type belongs to

colorstring nullable

The color of the activity type

enabledboolean nullable

Whether this activity type is enabled

exclude_from_time_trackingboolean nullable

Whether employees can select this activity type in timesheets and clock-ins

external_idstring nullable

External ID of the activity type

groupstring nullable

Group of the activity type

idinteger required

The unique ID of the activity type

namestring required

The name of the activity type

organisation_idinteger required

The ID of the organisation the activity type belongs to

parametersobject nullable

Scheduling parameters

prioritynumber nullable

Priority of the activity between 0 and 1

required_hoursnumber nullable

Required hours target

servicenumber nullable

Service time of the activity in seconds

shrinkagenumber nullable

Shrinkage of the activity in seconds

slanumber nullable

Service level agreement of the activity (percentage expressed as a fraction)

tagstring required

Tag associated with the activity type (e.g. Out of Office, Focus Time

time_createdstring date-time required

The time (UTC) when the activity type was created e.g 2023-07-27 06:30:00+00

time_updatedstring date-time required

The time (UTC) when the activity type was last updated e.g 2023-07-27 06:30:00+00

total_licensesinteger nullable
total_peopleinteger nullable
total_rolesinteger nullable
total_skillsinteger nullable
total_teamsinteger nullable