INinvoiceninja
task_status

Shows a TaskStatus Term

Changed on

Displays an TaskStatusby id

get/api/v1/task_statuses/{id}

Request

Path parameters

idstring string required

The TaskStatusHashed ID

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

Returns the TaskStatusobject

idstring

The task status hashed id

namestring

The task status name

colorstring

The task status color - hex value

task_status_orderinteger

The order of the task status

created_atnumber

Timestamp

is_deletedboolean

A boolean flag determining if the task status has been deleted

updated_atnumber

Timestamp

archived_atnumber

Timestamp

Example response

{
  "id": "Opnel5aKBz",
  "name": "Backlog",
  "color": "#000000",
  "task_status_order": 4,
  "created_at": 134341234234,
  "is_deleted": true,
  "updated_at": 134341234234,
  "archived_at": 134341234234
}

Changes

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e61df65649e2Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status