Tasks

How to list, tasks

Request Overview

Actions	Returns	Description
GET /api/v1/tasks	Collection	Get all tasks
GET /api/v1/tasks/{id}	200 Object	Get a task

Fields

Ticket Object

Field	Type	Specifics
id	Integer
number	String	Pefix + id
title	String
description	String
piority	String	very low, low, medium, high, very high
creator	Object
assignee	Object
customer	Object
watchers	Array
board	Object
status	Object
sub_tasks	Array
tags	Array
is_archived	Boolean
is_overdue	Boolean
subtasks_count_total	Boolean
subtasks_count_done	Boolean
attachments_count	Boolean
tickets_count	Boolean
due_at	Date String
done_at	Date String
created_at	Date String
updated_at	Date String
deleted_at	Date String

Requests

Get All Tasks

GET /api/v1/tasks Returns, a collection of tasks

GET /api/v1/tasks HTTP/1.1
Authorization: Bearer {{token}}
Hs-Client-Id: {{hs_client_id}}
Host: api.helpspace.com
Content-Type: application/json; charset=utf-8

200 Response

HTTP/1.1 200 OK
Content-Type: application/json
...

{
  "data": [
    {
      "id": 494,
      "number": "494",
      "title": "Set up Tasks API",
      "description": "<p>Build an endpoint ...<\/p>",
      "priority": "medium",
      "creator": {
        "id": 3,
        "name": "Stefan",
        "email": "stefan@helpspace.com"
      },
      "assignee": null,
      "customer": null,
      "watchers": [
        {
          "id": 1,
          "name": "John",
          "email": "john@helpspace.com"
        },
      ],
      "board": {
        "id": 1,
        "name": "Development"
      },
      "status": {
        "id": 4,
        "name": "QS",
        "color": null,
        "type": "none"
      },
      "sub_tasks": [
        {
          "id": 495,
          "title": "Create Documentation",
          "done_at": null,
          "created_at": "2025-04-25T09:59:55+00:00",
          "updated_at": "2025-04-25T09:59:55+00:00"
        }
      ],
      "tags": [
        {
          "id": 3,
          "name": "Feature Request",
          "slug": "feature-request",
          "color": "#7761D4",
          "type": "tasks"
        },
      ],
      "is_archived": false,
      "is_overdue": false,
      "subtasks_count_total": 1,
      "subtasks_count_done": 0,
      "attachments_count": 0,
      "tickets_count": 45,
      "due_at": null,
      "done_at": null,
      "created_at": "2025-04-24T14:49:34+00:00",
      "updated_at": "2025-04-25T13:04:04+00:00",
      "deleted_at": null
    },
    ...
  ],
  "links": {
    ...
  },
  "meta": {
    ...
  }
}

Information about links and meta, please read this article.

Filter with query parameters

To filter results, you can add query parameters to the request URL.
For example: /api/v1/tasks?assignees[]=mike%20smith&overdue=1

	Query Parameters	Possible Values
Results per page	per-page=10	1-50
Assignees	assignees[]=Mike&assignees[]=41 (name|id)	urlencoded string id
Boards	boards[]=Development&boards[]=5 (name|id)	urlencoded string id
Creators	creators[]=Hans&creators[]=5 (name|id)	urlencoded string id
Customers	customers[]=Berd&customers[]=47 (name|id)	urlencoded string id
Tickets	tickets[]=Ticketname&tickets[]=5 (name|id)	urlencoded string id
Tags	tags[]=customer%20support %20 is an urlencoded space character	urlencoded string
Tasks	tasks[]=building&tasks[]=34	urlencoded string
Titles	titles[]=some%20name %20 is an urlencoded space character	urlencoded string
Done	done[]=1	int
Archived	archived=only (with|only|without)	urlencoded string
Overdue	overdue=1 (0|1)	int
No Board	no_board=1	int