Skip to main content
GET
Get a task

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

Task ID

Response

OK

id
string
required

Task ID

number
string
required

Auto-generated task number

title
string
required

Task title

status
enum<string>
required

Task status

Available options:
OPEN,
IN_PROGRESS,
ON_HOLD,
COMPLETED,
CANCELLED
type
enum<string>
required

Task type

Available options:
call,
todo,
meeting
showTime
boolean
required

Whether to show time on the due date

assigneeIds
string[]
required

Assignee user IDs

tagIds
string[]
required

Tag IDs

description
string | null

Task description

priority
enum<string> | null

Task priority

Available options:
LOW,
MEDIUM,
HIGH
dueDate
string<date-time> | null

Due date

startDate
string<date-time> | null

Start date

durationMinutes
number | null

Duration in minutes

completedOn
string<date-time> | null

When the task was completed

entity
enum<string> | null

Linked entity type

Available options:
projects,
leads,
deals
entityId
string | null

Linked entity ID

projectId
string | null

Linked project ID

leadId
string | null

Linked lead ID

dealId
string | null

Linked deal ID

clientId
string | null

Linked client ID

contactId
string | null

Linked contact ID

createdById
string | null

Creator user ID

createdByName
string | null

Creator name

createdAt
string<date-time> | null

When the task was created

updatedAt
string<date-time> | null

When the task was last updated

{key}
any

Custom field values as top-level cf_* keys (for example cf_follow_up_type). There is no customFields wrapper.