The Task object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

parent_id string

is_group boolean

Default: false

subject string required

project string

issue string

type string

status string

priority string

color string

parent_task string

exp_start_date string

expected_time number

Default: 0

task_weight number

exp_end_date string

progress number

is_milestone boolean

Default: false

description string

depends_on_tasks string

act_start_date string

actual_time number

act_end_date string

total_costing_amount number

total_billing_amount number

review_date string

closing_date string

department string

company string

completed_by string

is_template boolean

Default: false

start integer

duration integer

completed_on string

template_task string

The Task object

{
  "id": "task_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "subject": "subject_example",
  "project": "project_example",
  "issue": "issue_example",
  "type": "type_example",
  "status": "draft",
  "priority": "priority_example",
  "color": "color_example",
  "parent_task": "parent_task_example",
  "exp_start_date": "2024-01-15",
  "expected_time": 0,
  "task_weight": 0,
  "exp_end_date": "2024-01-15",
  "progress": 0,
  "is_milestone": false,
  "description": "description_example",
  "depends_on_tasks": "depends_on_tasks_example",
  "act_start_date": "2024-01-15",
  "actual_time": 0,
  "act_end_date": "2024-01-15",
  "total_costing_amount": 0,
  "total_billing_amount": 0,
  "review_date": "2024-01-15",
  "closing_date": "2024-01-15",
  "department": "department_example",
  "company": "Example Corp",
  "completed_by": "completed_by_example",
  "is_template": false,
  "start": 0,
  "duration": 0,
  "completed_on": "completed_on_example",
  "template_task": "template_task_example"
}

GET /api/projects/task/{id}

Retrieve a task

Retrieves the details of an existing task. Supply the unique task ID that was returned from a previous request.

Path parameters

id string required

The identifier of the task to retrieve.

Returns

Returns the task object if a valid identifier was provided.

GET /api/projects/task/{id}

curl https://api.overplane.dev/api/projects/task/task_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "task_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "subject": "subject_example",
  "project": "project_example",
  "issue": "issue_example",
  "type": "type_example",
  "status": "draft",
  "priority": "priority_example",
  "color": "color_example",
  "parent_task": "parent_task_example",
  "exp_start_date": "2024-01-15",
  "expected_time": 0,
  "task_weight": 0,
  "exp_end_date": "2024-01-15",
  "progress": 0,
  "is_milestone": false,
  "description": "description_example",
  "depends_on_tasks": "depends_on_tasks_example",
  "act_start_date": "2024-01-15",
  "actual_time": 0,
  "act_end_date": "2024-01-15",
  "total_costing_amount": 0,
  "total_billing_amount": 0,
  "review_date": "2024-01-15",
  "closing_date": "2024-01-15",
  "department": "department_example",
  "company": "Example Corp",
  "completed_by": "completed_by_example",
  "is_template": false,
  "start": 0,
  "duration": 0,
  "completed_on": "completed_on_example",
  "template_task": "template_task_example"
}

GET /api/projects/task

List all tasks

Returns a list of tasks. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of task objects.

GET /api/projects/task

curl https://api.overplane.dev/api/projects/task \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "task_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "parent_id": null,
      "is_group": false,
      "subject": "subject_example",
      "project": "project_example",
      "issue": "issue_example",
      "type": "type_example",
      "status": "draft",
      "priority": "priority_example",
      "color": "color_example",
      "parent_task": "parent_task_example",
      "exp_start_date": "2024-01-15",
      "expected_time": 0,
      "task_weight": 0,
      "exp_end_date": "2024-01-15",
      "progress": 0,
      "is_milestone": false,
      "description": "description_example",
      "depends_on_tasks": "depends_on_tasks_example",
      "act_start_date": "2024-01-15",
      "actual_time": 0,
      "act_end_date": "2024-01-15",
      "total_costing_amount": 0,
      "total_billing_amount": 0,
      "review_date": "2024-01-15",
      "closing_date": "2024-01-15",
      "department": "department_example",
      "company": "Example Corp",
      "completed_by": "completed_by_example",
      "is_template": false,
      "start": 0,
      "duration": 0,
      "completed_on": "completed_on_example",
      "template_task": "template_task_example"
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/projects/task

Create a task

Creates a new task object.

Body parameters

parent_id string

is_group boolean

Default: false

subject string required

project string

issue string

type string

status string

priority string

color string

parent_task string

exp_start_date string

expected_time number

Default: 0

task_weight number

exp_end_date string

progress number

is_milestone boolean

Default: false

description string

depends_on_tasks string

act_start_date string

actual_time number

act_end_date string

total_costing_amount number

total_billing_amount number

review_date string

closing_date string

department string

company string

completed_by string

is_template boolean

Default: false

start integer

duration integer

completed_on string

template_task string

Returns

Returns the newly created task object if the call succeeded.

POST /api/projects/task

curl https://api.overplane.dev/api/projects/task \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"subject":"subject_example"}'

Response

{
  "id": "task_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "subject": "subject_example",
  "project": "project_example",
  "issue": "issue_example",
  "type": "type_example",
  "status": "draft",
  "priority": "priority_example",
  "color": "color_example",
  "parent_task": "parent_task_example",
  "exp_start_date": "2024-01-15",
  "expected_time": 0,
  "task_weight": 0,
  "exp_end_date": "2024-01-15",
  "progress": 0,
  "is_milestone": false,
  "description": "description_example",
  "depends_on_tasks": "depends_on_tasks_example",
  "act_start_date": "2024-01-15",
  "actual_time": 0,
  "act_end_date": "2024-01-15",
  "total_costing_amount": 0,
  "total_billing_amount": 0,
  "review_date": "2024-01-15",
  "closing_date": "2024-01-15",
  "department": "department_example",
  "company": "Example Corp",
  "completed_by": "completed_by_example",
  "is_template": false,
  "start": 0,
  "duration": 0,
  "completed_on": "completed_on_example",
  "template_task": "template_task_example"
}

PATCH /api/projects/task/{id}

Update a task

Updates the specified task by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the task to update.

Body parameters

parent_id string

is_group boolean

Default: false

subject string

project string

issue string

type string

status string

priority string

color string

parent_task string

exp_start_date string

expected_time number

Default: 0

task_weight number

exp_end_date string

progress number

is_milestone boolean

Default: false

description string

depends_on_tasks string

act_start_date string

actual_time number

act_end_date string

total_costing_amount number

total_billing_amount number

review_date string

closing_date string

department string

company string

completed_by string

is_template boolean

Default: false

start integer

duration integer

completed_on string

template_task string

Returns

Returns the updated task object.

PATCH /api/projects/task/{id}

curl https://api.overplane.dev/api/projects/task/task_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"is_group":false}'

Response

{
  "id": "task_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "subject": "subject_example",
  "project": "project_example",
  "issue": "issue_example",
  "type": "type_example",
  "status": "draft",
  "priority": "priority_example",
  "color": "color_example",
  "parent_task": "parent_task_example",
  "exp_start_date": "2024-01-15",
  "expected_time": 0,
  "task_weight": 0,
  "exp_end_date": "2024-01-15",
  "progress": 0,
  "is_milestone": false,
  "description": "description_example",
  "depends_on_tasks": "depends_on_tasks_example",
  "act_start_date": "2024-01-15",
  "actual_time": 0,
  "act_end_date": "2024-01-15",
  "total_costing_amount": 0,
  "total_billing_amount": 0,
  "review_date": "2024-01-15",
  "closing_date": "2024-01-15",
  "department": "department_example",
  "company": "Example Corp",
  "completed_by": "completed_by_example",
  "is_template": false,
  "start": 0,
  "duration": 0,
  "completed_on": "completed_on_example",
  "template_task": "template_task_example"
}

DELETE /api/projects/task/{id}

Delete a task

Permanently deletes a task. This cannot be undone.

Path parameters

id string required

The identifier of the task to delete.

Returns

Returns a confirmation that the task has been deleted.

DELETE /api/projects/task/{id}

curl https://api.overplane.dev/api/projects/task/task_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "task_abc123",
  "deleted": true
}

GET /api/projects/task/{id}/children

Get children

Returns the direct children of the specified node in the tree.

Path parameters

id string required

The identifier of the task to act on.

Returns

A list of direct child objects.

GET /api/projects/task/{id}/children

curl https://api.overplane.dev/api/projects/task/task_abc123/children \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "task_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "subject": "subject_example",
  "project": "project_example",
  "issue": "issue_example",
  "type": "type_example",
  "status": "draft",
  "priority": "priority_example",
  "color": "color_example",
  "parent_task": "parent_task_example",
  "exp_start_date": "2024-01-15",
  "expected_time": 0,
  "task_weight": 0,
  "exp_end_date": "2024-01-15",
  "progress": 0,
  "is_milestone": false,
  "description": "description_example",
  "depends_on_tasks": "depends_on_tasks_example",
  "act_start_date": "2024-01-15",
  "actual_time": 0,
  "act_end_date": "2024-01-15",
  "total_costing_amount": 0,
  "total_billing_amount": 0,
  "review_date": "2024-01-15",
  "closing_date": "2024-01-15",
  "department": "department_example",
  "company": "Example Corp",
  "completed_by": "completed_by_example",
  "is_template": false,
  "start": 0,
  "duration": 0,
  "completed_on": "completed_on_example",
  "template_task": "template_task_example"
}

GET /api/projects/task/{id}/ancestors

Get ancestors

Returns all ancestors from the immediate parent up to the root of the tree.

Path parameters

id string required

The identifier of the task to act on.

Returns

A list of ancestor objects from parent to root.

GET /api/projects/task/{id}/ancestors

curl https://api.overplane.dev/api/projects/task/task_abc123/ancestors \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "task_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "subject": "subject_example",
  "project": "project_example",
  "issue": "issue_example",
  "type": "type_example",
  "status": "draft",
  "priority": "priority_example",
  "color": "color_example",
  "parent_task": "parent_task_example",
  "exp_start_date": "2024-01-15",
  "expected_time": 0,
  "task_weight": 0,
  "exp_end_date": "2024-01-15",
  "progress": 0,
  "is_milestone": false,
  "description": "description_example",
  "depends_on_tasks": "depends_on_tasks_example",
  "act_start_date": "2024-01-15",
  "actual_time": 0,
  "act_end_date": "2024-01-15",
  "total_costing_amount": 0,
  "total_billing_amount": 0,
  "review_date": "2024-01-15",
  "closing_date": "2024-01-15",
  "department": "department_example",
  "company": "Example Corp",
  "completed_by": "completed_by_example",
  "is_template": false,
  "start": 0,
  "duration": 0,
  "completed_on": "completed_on_example",
  "template_task": "template_task_example"
}

GET /api/projects/task/{id}/descendants

Get descendants

Returns all descendants of the specified node in the tree.

Path parameters

id string required

The identifier of the task to act on.

Returns

A list of all descendant objects.

GET /api/projects/task/{id}/descendants

curl https://api.overplane.dev/api/projects/task/task_abc123/descendants \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "task_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "parent_id": null,
  "is_group": false,
  "subject": "subject_example",
  "project": "project_example",
  "issue": "issue_example",
  "type": "type_example",
  "status": "draft",
  "priority": "priority_example",
  "color": "color_example",
  "parent_task": "parent_task_example",
  "exp_start_date": "2024-01-15",
  "expected_time": 0,
  "task_weight": 0,
  "exp_end_date": "2024-01-15",
  "progress": 0,
  "is_milestone": false,
  "description": "description_example",
  "depends_on_tasks": "depends_on_tasks_example",
  "act_start_date": "2024-01-15",
  "actual_time": 0,
  "act_end_date": "2024-01-15",
  "total_costing_amount": 0,
  "total_billing_amount": 0,
  "review_date": "2024-01-15",
  "closing_date": "2024-01-15",
  "department": "department_example",
  "company": "Example Corp",
  "completed_by": "completed_by_example",
  "is_template": false,
  "start": 0,
  "duration": 0,
  "completed_on": "completed_on_example",
  "template_task": "template_task_example"
}

Line items

Child objects that belong to this task. These are accessed via the parent's ID.

Task Depends On

Attributes

idx integer

task_id string required

task string

subject string

project string

Endpoints

GET /api/projects/task-depends-on?parent_id={id}

POST /api/projects/task-depends-on

PATCH /api/projects/task-depends-on/{id}

DELETE /api/projects/task-depends-on/{id}

POST /api/projects/task-depends-on/reorder

Task Depends On object

{
  "id": "task-depends-on_abc123",
  "idx": 1,
  "task_id": "task_id_example",
  "task": "task_example",
  "subject": "subject_example",
  "project": "project_example"
}

The Task object

Attributes

Retrieve a task

Path parameters

Returns

List all tasks

Query parameters

Returns

Create a task

Body parameters

Returns

Update a task

Path parameters

Body parameters

Returns

Delete a task

Path parameters

Returns

Get children

Path parameters

Returns

Get ancestors

Path parameters

Returns

Get descendants

Path parameters

Returns

Line items

Task Depends On

Attributes

Endpoints

Coming Soon