Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Status transition

A transition permits one status change: from a source status to a target status. A ticket may only move where a transition exists — PATCH /v1/tickets/{ticketId} answers with 400 otherwise.

Transitions are directional. Permitting open → in_progress does not permit the way back; that needs its own transition.

List permitted status changes

get

Returns which status changes the tenant permits. A ticket may only move from one status to another if a transition exists for that pair — PATCH /v1/tickets/{ticketId} answers with 400 otherwise.

Filterable — paths into both ends, such as sourceStatus.name or targetStatus.isDefault.

Sortable — sourceStatus.<field> and targetStatus.<field>, for example sort=sourceStatus.position,targetStatus.position.

Authorizations
AuthorizationstringRequired

Token issued by the central equipme authentication, sent as Bearer <token>.

Query parameters
filterstringOptional

JSON filter expression

searchstringOptional

Free-text term — no effect here

sortstringOptional

Comma-separated field:direction terms

fieldsstringOptional

Selection of fields and relations

Example: sourceStatus.name,targetStatus.name
offsetintegerOptional

Number of entries to skip

Default: 0
limitintegerOptional

Page size, 1 to 100

Default: 100
Responses
200

OK

application/json
countintegerOptional
get/v1/ticket-status-transitions
GET /api/v1/ticket-status-transitions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "data": [
    {
      "role": "text",
      "sourceStatus": {
        "allowedSourceStatuses": [
          {
            "allowedSourceStatuses": "[Circular Reference]",
            "allowedTargetStatuses": "[Circular Reference]",
            "color": "#f5a623",
            "createdAt": "2026-01-01T00:00:00.000Z",
            "displayName": "In progress",
            "isDefault": true,
            "name": "in_progress",
            "position": 2,
            "tenant": {
              "id": 1,
              "name": "text"
            },
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "allowedTargetStatuses": [
          {
            "allowedSourceStatuses": "[Circular Reference]",
            "allowedTargetStatuses": "[Circular Reference]",
            "color": "#f5a623",
            "createdAt": "2026-01-01T00:00:00.000Z",
            "displayName": "In progress",
            "isDefault": true,
            "name": "in_progress",
            "position": 2,
            "tenant": {
              "id": 1,
              "name": "text"
            },
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "color": "#f5a623",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "displayName": "In progress",
        "isDefault": true,
        "name": "in_progress",
        "position": 2,
        "tenant": {
          "id": 1,
          "name": "text"
        },
        "updatedAt": "2026-01-01T00:00:00.000Z"
      },
      "targetStatus": {
        "allowedSourceStatuses": [
          {
            "allowedSourceStatuses": "[Circular Reference]",
            "allowedTargetStatuses": "[Circular Reference]",
            "color": "#f5a623",
            "createdAt": "2026-01-01T00:00:00.000Z",
            "displayName": "In progress",
            "isDefault": true,
            "name": "in_progress",
            "position": 2,
            "tenant": {
              "id": 1,
              "name": "text"
            },
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "allowedTargetStatuses": [
          {
            "allowedSourceStatuses": "[Circular Reference]",
            "allowedTargetStatuses": "[Circular Reference]",
            "color": "#f5a623",
            "createdAt": "2026-01-01T00:00:00.000Z",
            "displayName": "In progress",
            "isDefault": true,
            "name": "in_progress",
            "position": 2,
            "tenant": {
              "id": 1,
              "name": "text"
            },
            "updatedAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "color": "#f5a623",
        "createdAt": "2026-01-01T00:00:00.000Z",
        "displayName": "In progress",
        "isDefault": true,
        "name": "in_progress",
        "position": 2,
        "tenant": {
          "id": 1,
          "name": "text"
        },
        "updatedAt": "2026-01-01T00:00:00.000Z"
      }
    }
  ]
}

Permit a status change

post

Permits a status change from sourceStatusName to targetStatusName. Both statuses have to exist and they have to differ, otherwise the request is answered with 400. A transition that already exists is answered with 409.

role restricts the transition to a role; leaving it out lets it apply to everyone.

Authorizations
AuthorizationstringRequired

Token issued by the central equipme authentication, sent as Bearer <token>.

Body
objectOptional
or
Responses
201

Created

application/json
post/v1/ticket-status-transitions
POST /api/v1/ticket-status-transitions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "data": {
    "role": "text",
    "sourceStatus": {
      "allowedSourceStatuses": [
        {
          "allowedSourceStatuses": [
            "[Circular Reference]"
          ],
          "allowedTargetStatuses": [
            "[Circular Reference]"
          ],
          "color": "#f5a623",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "displayName": "In progress",
          "isDefault": true,
          "name": "in_progress",
          "position": 2,
          "tenant": {
            "id": 1,
            "name": "text"
          },
          "updatedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "allowedTargetStatuses": [
        {
          "allowedSourceStatuses": [
            {
              "allowedSourceStatuses": [
                "[Circular Reference]"
              ],
              "allowedTargetStatuses": [
                "[Circular Reference]"
              ],
              "color": "#f5a623",
              "createdAt": "2026-01-01T00:00:00.000Z",
              "displayName": "In progress",
              "isDefault": true,
              "name": "in_progress",
              "position": 2,
              "tenant": {
                "id": 1,
                "name": "text"
              },
              "updatedAt": "2026-01-01T00:00:00.000Z"
            }
          ],
          "allowedTargetStatuses": [
            "[Circular Reference]"
          ],
          "color": "#f5a623",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "displayName": "In progress",
          "isDefault": true,
          "name": "in_progress",
          "position": 2,
          "tenant": {
            "id": 1,
            "name": "text"
          },
          "updatedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "color": "#f5a623",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "displayName": "In progress",
      "isDefault": true,
      "name": "in_progress",
      "position": 2,
      "tenant": {
        "id": 1,
        "name": "text"
      },
      "updatedAt": "2026-01-01T00:00:00.000Z"
    },
    "targetStatus": {
      "allowedSourceStatuses": [
        {
          "allowedSourceStatuses": [
            "[Circular Reference]"
          ],
          "allowedTargetStatuses": [
            "[Circular Reference]"
          ],
          "color": "#f5a623",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "displayName": "In progress",
          "isDefault": true,
          "name": "in_progress",
          "position": 2,
          "tenant": {
            "id": 1,
            "name": "text"
          },
          "updatedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "allowedTargetStatuses": [
        {
          "allowedSourceStatuses": [
            {
              "allowedSourceStatuses": [
                "[Circular Reference]"
              ],
              "allowedTargetStatuses": [
                "[Circular Reference]"
              ],
              "color": "#f5a623",
              "createdAt": "2026-01-01T00:00:00.000Z",
              "displayName": "In progress",
              "isDefault": true,
              "name": "in_progress",
              "position": 2,
              "tenant": {
                "id": 1,
                "name": "text"
              },
              "updatedAt": "2026-01-01T00:00:00.000Z"
            }
          ],
          "allowedTargetStatuses": [
            "[Circular Reference]"
          ],
          "color": "#f5a623",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "displayName": "In progress",
          "isDefault": true,
          "name": "in_progress",
          "position": 2,
          "tenant": {
            "id": 1,
            "name": "text"
          },
          "updatedAt": "2026-01-01T00:00:00.000Z"
        }
      ],
      "color": "#f5a623",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "displayName": "In progress",
      "isDefault": true,
      "name": "in_progress",
      "position": 2,
      "tenant": {
        "id": 1,
        "name": "text"
      },
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  }
}

Withdraw a permitted status change

delete

Withdraws a permitted status change. The pair is named in the body rather than in the path, because a transition is identified by its two ends. Tickets already in the target status are unaffected — only future moves are refused.

Authorizations
AuthorizationstringRequired

Token issued by the central equipme authentication, sent as Bearer <token>.

Body
objectOptional
or
Responses
204

No Content

No content
delete/v1/ticket-status-transitions
DELETE /api/v1/ticket-status-transitions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
No content

Last updated

Was this helpful?