API Documentation

API Endpoint

Workflow Statuses

Workflow Statuses

The Workflow Status object represents the current state of a task, enabling users to define and monitor task stages.

Every Workflow can have multiple Workflow statuses. There are three Workflow status categories:

  • not_started

  • started

  • closed

Supported filter params

  • name

  • workflow_id

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

Supported sort params

  • name

  • position

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": "3374",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": "1",
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2220"
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "3375",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": "1",
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2220"
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "3376",
      "type": "workflow_statuses",
      "attributes": {
        "name": "Open",
        "color_id": "1",
        "position": 1,
        "category_id": 2
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "2220"
          }
        },
        "workflow": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/workflow_statuses?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/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
  }
}

Get workflow statuses
GET/api/v2/workflow_statuses

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

GET  /api/v2/workflow_statuses/3377

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": "3377",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": "1",
      "position": 1,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2221"
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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": "2774"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3379",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": "1",
      "position": 1,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2222"
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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": "2775"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "3381",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Open",
      "color_id": "1",
      "position": 1,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2223"
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

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": "2777"
      }
    }
  }
}
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/3385

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": "3385",
    "type": "workflow_statuses",
    "attributes": {
      "name": "Closed",
      "color_id": "1",
      "position": 1,
      "category_id": 2
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2226"
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/workflow_statuses/3386

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": "3386",
    "type": "workflow_statuses",
    "attributes": {
      "name": "More closed",
      "color_id": "1",
      "position": 1,
      "category_id": 3
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "2227"
        }
      },
      "workflow": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/workflow_statuses/3387

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 statusdeletes workflow statusreturns error

DELETE  /api/v2/workflow_statuses/3388

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": "3396"
    }
  }
}
Responses204
This response has no content.

DELETE  /api/v2/workflow_statuses/3397

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": "3405"
    }
  }
}
Responses204
This response has no content.

DELETE  /api/v2/workflow_statuses/3406

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 21 Jul 2025