API Documentation

API Endpoint

Workflow Statuses

Workflow Statuses

Supported filter params

  • name

  • workflow_id

  • category_id (1: not started, 2: started, 3: closed)

Supported sort params

  • name
GET /api/v2/workflow_statuses
Requestsreturns workflow statuses

GET  /api/v2/workflow_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "556",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": 1,
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1727"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "445"
          }
        }
      }
    },
    {
      "id": "557",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": 1,
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1727"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "446"
          }
        }
      }
    },
    {
      "id": "558",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": 1,
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1727"
          }
        },
        "workflow": {
          "data": {
            "type": "workflows",
            "id": "447"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "445",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1727"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "556"
            }
          ]
        }
      }
    },
    {
      "id": "446",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1727"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "557"
            }
          ]
        }
      }
    },
    {
      "id": "447",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1727"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "558"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/workflow_statuses?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/workflow_statuses?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get workflow statuses
GET/api/v2/workflow_statuses


GET /api/v2/workflow_statuses/1
Requestsreturns workflow status

GET  /api/v2/workflow_statuses/559

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "559",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": 1,
      "position": 1,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1728"
        }
      },
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "448"
        }
      }
    }
  },
  "included": [
    {
      "id": "448",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1728"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "559"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets a workflow status
GET/api/v2/workflow_statuses/{id}

URI Parameters
HideShow
id
number (required) Example: 1

workflow_status id


POST /api/v2/workflow_statuses
Requestscreates workflow statuscreates workflow statusreturns errorreturns error

POST  /api/v2/workflow_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": 1,
      "category_id": 2
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "449"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "561",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": 1,
      "position": 2,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1729"
        }
      },
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "449"
        }
      }
    }
  },
  "included": [
    {
      "id": "449",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1729"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "560"
            },
            {
              "type": "workflow_statuses",
              "id": "561"
            }
          ]
        }
      }
    },
    {
      "id": "560",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": 1,
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1729"
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/workflow_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": 1,
      "category_id": 2
    },
    "relationships": {
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "450"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "563",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": 1,
      "position": 2,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1730"
        }
      },
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "450"
        }
      }
    }
  },
  "included": [
    {
      "id": "450",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1730"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "562"
            },
            {
              "type": "workflow_statuses",
              "id": "563"
            }
          ]
        }
      }
    },
    {
      "id": "562",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": 1,
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1730"
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

POST  /api/v2/workflow_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "type": "workflow_statuses",
  "attributes": {
    "name": ""
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/workflow"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/category_id"
      }
    }
  ]
}

POST  /api/v2/workflow_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "type": "workflow_statuses",
  "attributes": {
    "name": "Closed 2",
    "category_id": "3"
  },
  "relationships": {
    "workflow": {
      "data": {
        "type": "workflows",
        "id": "452"
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/workflow"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/category_id"
      }
    }
  ]
}

Create an workflow status
POST/api/v2/workflow_statuses

URI Parameters
HideShow
name
string (required) Example: Name

name

workflow_id
number (required) Example: 1

workflow id

color_id
number (required) Example: 1

color id

category_id
number (required) Example: 1

workflow status category (1: not started, 2: started, 3: closed)

position
number (required) Example: 1

position in category


PATCH /api/v2/workflow_statuses/1
Requestsupdates workflow statusupdates workflow statusreturns error

PATCH  /api/v2/workflow_statuses/567

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "name": "Closed"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "567",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Closed",
      "color_id": 1,
      "position": 1,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1733"
        }
      },
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "453"
        }
      }
    }
  },
  "included": [
    {
      "id": "453",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1733"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "567"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/workflow_statuses/568

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "name": "More closed"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "568",
    "type": "workflow_statuses",
    "attributes": {
      "name": "More closed",
      "color_id": 1,
      "position": 1,
      "category_id": 3
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "1734"
        }
      },
      "workflow": {
        "data": {
          "type": "workflows",
          "id": "454"
        }
      }
    }
  },
  "included": [
    {
      "id": "454",
      "type": "workflows",
      "attributes": {
        "name": "Simple workflow",
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "1734"
          }
        },
        "workflow_statuses": {
          "data": [
            {
              "type": "workflow_statuses",
              "id": "568"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "workflows": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      },
      "time_off_sync": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

PATCH  /api/v2/workflow_statuses/569

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Update an workflow status
PATCH/api/v2/workflow_statuses/{id}

URI Parameters
HideShow
id
number (required) Example: 1

workflow_status id


DELETE /api/v2/workflow_statuses/1
Requestsdeletes workflow statusreturns error

DELETE  /api/v2/workflow_statuses/570

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "target_workflow_status_id": "571"
    }
  }
}
Responses204
This response has no content.

DELETE  /api/v2/workflow_statuses/573

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "workflow_statuses",
    "attributes": {
      "target_workflow_status_id": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/target_workflow_status_id"
      }
    }
  ]
}

Deletes a workflow status and moves tasks to other workflow status
DELETE/api/v2/workflow_statuses/{id}

URI Parameters
HideShow
id
number (required) Example: 1

workflow_status id

target_workflow_status_id
number (required) Example: 1

workflow status where the tasks from the current workflow status will be moved


Generated by aglio on 23 Oct 2021