Skip to main content
GET
Get a Task

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.

zivio-tenant-id
string
header
required

Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.

Path Parameters

id
integer
required

Task ID

Response

Task details

id
integer
name
string
description
string
status
enum<string>
Available options:
pending,
completed,
cancelled
Example:

"pending"

due_on
string
overdue
boolean
Example:

true

taskable_type
string
taskable_id
integer
taskable_scope
string
subject
object

What the task is about: the internal taskable, the record the api_actions act on, and the project it belongs to when there is one

api_actions
object[]

V4 operations that action this kind of task, with ids filled in where known. Empty means the task can only be actioned in the web UI (use ui_path). Actioning the underlying record completes the task automatically, so prefer these over POST /tasks/{id}/complete.

completed_at
string
completed_by
object | null
assignees
object[]

Every user the task was assigned to, with whether each has dismissed it

dismissed
boolean
Example:

true

ui_path
string

Relative web UI path for a human to action the task

Example:

"/hiring/projects/123"

created_at
string
updated_at
string