Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Core Tools

Tasks

12 endpoints12 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_categoriesList task item categories
  2. GET /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_commentsList Task Item Comments
  3. POST /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_commentsCreate a task item comment
  4. PATCH /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_comments/{id}Update a task item comment
  5. DELETE /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_comments/{id}Delete a task item comment
  6. GET /rest/v1.0/task_itemsList task items
  7. POST /rest/v1.0/task_itemsCreate task item
  8. GET /rest/v1.0/task_items/{id}Show task item
  9. PATCH /rest/v1.0/task_items/{id}Update task item
  10. DELETE /rest/v1.0/task_items/{id}Destroy task item
  11. GET /rest/v1.0/task_items/assigneesList Task Items Assignee options
  12. GET /rest/v1.0/task_items/assignees/currentList Assignees for Accessible Tasks
GET /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_categories

List task item categories

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • view
    stringquery

Response · 200 · integer[] | object[]

No documented fields.

GET /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_comments

List Task Item Comments

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • project_id
    integerpathrequired
  • filters[task_item_id]
    integerquery
  • filters[created_by_id]
    integer[]query
  • page
    integerquery
  • per_page
    integerquery
  • view
    stringquery

Response · 200 · object[]

  • id
    integer
  • comment
    string
  • status
    string
  • task_item_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
POST /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_comments

Create a task item comment

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • project_id
    integerpathrequired
  • view
    stringquery

Request body

  • task_item_comment
    object

Response · 201 · object

  • id
    integer
  • comment
    string
  • status
    string
  • task_item_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
PATCH /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_comments/{id}

Update a task item comment

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired
  • view
    stringquery

Request body

  • task_item_comment
    object

Response · 200 · object

  • id
    integer
  • comment
    string
  • status
    string
  • task_item_id
    integer
  • created_by_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
DELETE /rest/v1.0/companies/{company_id}/projects/{project_id}/task_item_comments/{id}

Delete a task item comment

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • company_id
    integerpathrequired
  • project_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200

No response body.

GET /rest/v1.0/task_items

List task items

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[query]
    stringquery
  • filters[assigned_id]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[created_by_id]
    integer[]query
  • filters[due_date]
    stringquery
  • filters[status]
    string[]query
  • filters[task_item_category_id]
    stringquery
  • filters[id]
    integer[]query
  • sort
    stringquery
  • view
    stringquery

Response · 200 · integer[] | object[]

No documented fields.

POST /rest/v1.0/task_items

Create task item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • view
    stringquery

Request body

  • task_item
    objectrequired

Response · 201 · object

  • id
    integer
  • title
    string
GET /rest/v1.0/task_items/{id}

Show task item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • id
    integerpathrequired
  • view
    stringquery

Response · 200 · object

  • id
    integer
  • title
    string
PATCH /rest/v1.0/task_items/{id}

Update task item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • id
    integerpathrequired
  • view
    stringquery

Request body

  • task_item
    objectrequired

Response · 200 · object

  • id
    integer
  • title
    string
DELETE /rest/v1.0/task_items/{id}

Destroy task item

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • id
    integerpathrequired
  • view
    stringquery

Response · 204

No response body.

GET /rest/v1.0/task_items/assignees

List Task Items Assignee options

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[search]
    stringquery

Response · 200 · object[]

  • login
    string
  • id
    integer
  • name
    string
  • locale
    string
GET /rest/v1.0/task_items/assignees/current

List Assignees for Accessible Tasks

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • login
    string
  • id
    integer
  • name
    string
  • locale
    string

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file