tasks.statuses.getList

Returns the list of task statuses selected in projects’ settings.

Parameters

• format GET Optional

  Sets response format. Available options: json (default), xml.

Return value

Array with the following keys:

• data array The status list. Each list item is an array with the following keys:
• data[]['id'] int Status ID.
• data[]['name'] string Status name.
• data[]['button'] string Caption on the button which will be used to transfer tasks to the new status.
• data[]['sort'] int Sort value.
• data[]['special'] bool Flag denoting whether the status is a system one (built in the Teamwork app).
• data[]['params'] array Additional parameters as an array with the following keys:
• data[]['params']['allow_clear_assign'] bool Flag denoting whether it is allowed to transfer the task to this status without assignment to any user.
• data[]['params']['allow_comment'] bool Flag denoting the possibility to add comments to tasks in this status.
• data[]['params']['assign'] string|null The user to whom the task must be assigned when transferred to this status: 'author' (who created the task), 'user' (a specified user), 'select' (offer the selection of a user to the one who changes the task status), '' (keep the the assigned user selection unchanged).
• data[]['params']['assign_user'] int|null ID of the user to whom the task must be assigned if the assign parameter contains value 'user'.
• data[]['params']['button_color'] string|null HTML color value for the button background.
• data[]['params']['title_color'] string|null HTML color value for the button text.
• ['counts'] array Array of task counters for this status with the following keys:
• data[]['counts']['active'] int Number of active tasks.
• data[]['counts']['active_priority'] int Number of active tasks with a high priority.
• data[]['counts']['closed'] int Number of closed tasks.
• data[]['counts']['total'] int Total number of tasks.

Example