API: Statuses
| Link | Description | Type | Constraints | Supported operations |
|---|---|---|---|---|
| self | This status | Status | not null | READ |
| Property | Description | Type | Constraints | Supported operations |
|---|---|---|---|---|
| id | Status id | Integer | x > 0 | READ |
| name | Status name | String | READ | |
| position | Sort index of the status | Integer | READ | |
| isDefault | Boolean | READ | ||
| isClosed | are tickets of this status considered closed? | Boolean | READ | |
| isReadonly | are tickets of this status read only? | Boolean | READ | |
| defaultDoneRatio | The percentageDone being applied when changing to this status | Integer | 0 <= x <= 100 | READ |
StatusCollectionModel
{
"allOf": [
"$ref": "#/components/schemas/CollectionModel"
"type": "object",
"required": [
"_links",
"_embedded"
"properties": {
"_links": {
"type": "object",
"required": [
"self"
"properties": {
"self": {
"allOf": [
"$ref": "#/components/schemas/Link"
"description": "This file links collection\n\n**Resource**: StatusCollectionModel"
"_embedded": {
"type": "object",
"required": [
"elements"
"properties": {
"elements": {
"type": "array",
"items":
{
"$ref": "#/components/schemas/StatusModel"
403
Returned if the client does not have sufficient permissions.
Required permission: view work package (on any project)
{
"_type": "Error",
"errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
"message": "You are not allowed to see the statuses."
ErrorResponse
{
"type": "object",
"required": [
"_type",
"errorIdentifier",
"message"
"properties": {
"_embedded": {
"type": "object",
"properties": {
"details": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"example": "project"
"_type": {
"type": "string",
"enum": [
"Error"
"errorIdentifier": {
"type": "string",
"example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
"message": {
"type": "string",
"example": "Project can't be blank."