Skip to main content
GET
/
tasks
/
{id}
Get a task
curl --request GET \
  --url https://api.heffl.com/api/v1/tasks/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": 123,
  "number": "<string>",
  "title": "<string>",
  "status": "<string>",
  "type": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "priority": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "startDate": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
number
required

Task ID

Response

200 - application/json

OK

id
number
required

Task ID

number
string
required

Auto-generated task number

title
string
required

Task title

status
string
required

Task status

type
string
required

Task type

createdAt
string<date-time>
required

When the task was created

description
string | null

Task description

priority
string | null

Task priority

dueDate
string<date-time> | null

Due date

startDate
string<date-time> | null

Start date