Skip to main content
GET
Get Task

Authorizations

X-Api-Key
string
header
required

Path Parameters

task_id
string
required

Task ID

Example:

"ev:3000010034"

Query Parameters

opts_include_billing
integer

Set to 1 to include billing data on returned tasks: rate (cents per hour) and amount (round(time * rate / 3600)). Requires billing permissions; otherwise billing is omitted.

Example:

1

Response

OK

id
string
required
Example:

"ev:9876543210"

name
string
required
Example:

"Task Name"

projects
string[]
required

List of projects ID

Example:
type
string

Object kind reported by the source platform.

Example:

"task"

url
string

Link to the task in the source platform. Absent for native Everhour tasks.

Example:

"https://github.com/acme/web/issues/8688"

number
string

Issue number or key in the source platform. Absent for native Everhour tasks.

Example:

"ED-774"

section
number | null

Section ID

Example:

1234

labels
string[]
Example:
position
number
Example:

1

description
string | null
dueAt
string | null

Format: Y-m-d H:i:s

Example:

"2018-03-05 16:00:00"

dueOn
string | null

Due date without a time component. Format: Y-m-d

Example:

"2024-10-31"

status
enum<string>
Available options:
open,
completed,
closed
Example:

"open"

completed
boolean

Mirrors status — true when the task is done in the source platform.

Example:

false

completedAt
string | null

When the task was completed. Format: Y-m-d H:i:s

Example:

"2024-01-24 14:36:20"

createdAt
string

Format: Y-m-d H:i:s

Example:

"2023-04-07 13:11:20"

createdBy
number

ID of the user who created the task. Native Everhour tasks only.

Example:

1304

favorite
boolean

Whether you marked this task as a favorite.

Example:

false

assignees
object[] | null

Who the task is assigned to. null when the source platform reports no assignee data, and an empty array when the task is unassigned.

iteration
string

Sprint, board column, or section the task sits in, as reported by the source platform.

Example:

"In Progress"

color
string

Task color as a hex value. Native Everhour tasks only.

Example:

"#edacc7"

comments
number

Number of comments on the task.

Example:

1

time
object
estimate
object
attributes
object

Custom attributes from integration

Example:
metrics
object

Custom metrics from integration

Example:
unbillable
boolean

true when the task is marked as non-billable.

Example:

false