HR Tasks

List of valid attributes:

Attribute	Description	Specifics
account_id	ID of the account the task belongs to	Cannot be set
assignee_id	ID of the user assigned to the task	Optional. Must belong to the same account
deadline	Deadline for the task	Optional
description	Description of the task	Optional
name	Name of the task	Must be set, Length 1-50 characters
status	Status of the task	Must be set. One of open, in_progress, done
account_label_ids	Array of account label IDs to attach to the task	Create only.
account_label_assignments		Update only
account_label_id	ID of the account label to add/delete
_delete	Indicator to delete the label	Don’t send this parameter if you don’t want to delete the label. Set it to true if you do.

The following relationships can be included in requests:

Relationship	Type
assignee	belongs_to
account_labels	has_many

Meta data: Permissions

Group	Description
actions	Contains permissions to edit or delete an HR task

Create

Example request:

{
  "data": {
    "type": "hr_task",
    "attributes": {
      "name": "Task name",
      "description": "Task description",
      "status": "open",
      "assignee_id": "9ee58efe-7ce5-4143-99d3-954303b188f3",
      "deadline": "2026-08-15T17:00:00.000Z",
      "account_label_ids": [
        "2dfdd8d7-418b-40fd-b98a-f8e531a363e0",
        "99a7c77d-fecc-4a2e-9e7c-f1b44e475ac0"
      ]
    }
  }
}

Example response:

{
  "data": {
    "id": "baf9c6a1-4e8b-492e-a972-a03bd0fd52ef",
    "type": "hr_task",
    "attributes": {
      "account_id": "c2c3a4c9-5a9e-4ad8-9b7b-9a7d6c5b2e1f",
      "assignee_id": "9ee58efe-7ce5-4143-99d3-954303b188f3",
      "deadline": "2026-08-15T17:00:00.000Z",
      "description": "Task description",
      "name": "Task name",
      "status": "open"
    }
  }
}

This endpoint creates a new HR task. If account_label_ids are provided, the labels are also assigned to the new task.

HTTP Request

POST /api/v1/hr_tasks

Update

Example request:

{
  "data": {
    "type": "hr_task",
    "attributes": {
      "name": "Updated task name",
      "description": "Updated description",
      "account_label_assignments": [
        { "account_label_id": "2dfdd8d7-418b-40fd-b98a-f8e531a363e0" },
        {
          "account_label_id": "99a7c77d-fecc-4a2e-9e7c-f1b44e475ac0",
          "_delete": true
        }
      ]
    }
  }
}

Example response:

{
  "data": {
    "id": "baf9c6a1-4e8b-492e-a972-a03bd0fd52ef",
    "type": "hr_task",
    "attributes": {
      "account_id": "c2c3a4c9-5a9e-4ad8-9b7b-9a7d6c5b2e1f",
      "assignee_id": "9ee58efe-7ce5-4143-99d3-954303b188f3",
      "deadline": "2026-08-15T17:00:00.000Z",
      "description": "Updated description",
      "name": "Updated task name",
      "status": "open"
    }
  }
}

This endpoint updates an existing HR task. If account_label_assignments are provided, labels are added or removed (_delete: true) accordingly.

HTTP Request

PUT /api/v1/hr_tasks/:hr_task_id

URL Parameters

Parameter	Description
hr_task_id	The ID of the HR task to update

Show

Example response:

{
  "data": {
    "id": "baf9c6a1-4e8b-492e-a972-a03bd0fd52ef",
    "type": "hr_task",
    "attributes": {
      "account_id": "c2c3a4c9-5a9e-4ad8-9b7b-9a7d6c5b2e1f",
      "assignee_id": "9ee58efe-7ce5-4143-99d3-954303b188f3",
      "deadline": "2026-08-15T17:00:00.000Z",
      "description": "Task description",
      "name": "Task name",
      "status": "open"
    }
  }
}

This endpoint returns an HR task.

HTTP Request

GET /api/v1/hr_tasks/:hr_task_id

URL Parameters

Parameter	Description
hr_task_id	The ID of the HR task to return

List

Example response:

{
  "data": [
    {
      "id": "baf9c6a1-4e8b-492e-a972-a03bd0fd52ef",
      "type": "hr_task",
      "attributes": {
        "account_id": "c2c3a4c9-5a9e-4ad8-9b7b-9a7d6c5b2e1f",
        "assignee_id": "9ee58efe-7ce5-4143-99d3-954303b188f3",
        "deadline": "2026-08-15T17:00:00.000Z",
        "description": "Task description",
        "name": "Task name",
        "status": "open"
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns HR tasks of the current user’s account.

HTTP Request

GET /api/v1/hr_tasks

Delete

Example response:

{
  "data": {
    "id": "baf9c6a1-4e8b-492e-a972-a03bd0fd52ef",
    "type": "hr_task",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes the HR task with the given ID.

HTTP Request

DELETE /api/v1/hr_tasks/:hr_task_id

URL Parameters

Parameter	Description
hr_task_id	The ID of the HR task to delete