Skip to main content

List project plan tasks

GET 
/api/project-plan-tasks

Required permissions:

  • project_plan.view: allows view of project plan tasks.

Custom fields​

Single-option custom fields appear in the response as dynamic fields named like custom_field_55 where 55 is the ID of the custom field. The value is the ID of the selected option, or null when no option is set.

Request​

Query Parameters

    project_id integer
    project_plan_area_id integer

    Possible values: >= 1

    Filter items by the project_plan_area_id field.

    employee_id integer

    Possible values: >= 1

    Filter tasks assigned (via project plan effort) to the given employee_id.

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field.

    Operators:

    Usage: eq:{value}

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of project plan tasks.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired

    Possible values: <= 255 characters

    The name of the project plan task

    sort floatrequired

    The sort order of the task within its area

    project_plan_area_id integerrequired

    Possible values: >= 1

    The ID of the project plan area this task belongs to

    budget_task_id integernullable

    Possible values: >= 1

    The ID of the budget task linked to this project plan task, if any

    start_date datenullable

    The start date of the task, formatted as YYYY-MM-DD

    end_date datenullable

    The end date of the task, formatted as YYYY-MM-DD

    notes stringnullable

    Free-form notes attached to the task

    status_key stringnullable

    Possible values: [not-started, in-progress, blocked, done, closed]

    The status of the task

    depends_on_id integernullable

    Possible values: >= 1

    The ID of the task this task depends on, if any

    dependency_type stringnullable

    Possible values: [start-to-start, finish-to-start, start-to-finish, finish-to-finish]

    The dependency type between this task and the one it depends on

  • ]

Loading...