> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/ticket-status.md).
# Ticket status
A **status** says where a ticket stands in its lifecycle. Statuses are defined per tenant and identified by their `name`; `displayName` is the label meant for people and can be changed freely.
Exactly one status is the tenant's default — the one new tickets start in. `position` is the order they are meant to be shown in.
A ticket cannot move between arbitrary statuses: the permitted moves are defined as *Status Transitions*.
## List ticket statuses
> Returns the tenant's ticket statuses.\
> \
> \*\*Filterable and sortable\*\* — \`name\`, \`displayName\`, \`color\`, \`isDefault\`, \`position\`, \`createdAt\`,\
> \`updatedAt\`.\
> \
> \`position\` is the order they are meant to be shown in, \`isDefault\` marks the status a new ticket\
> starts in. Exactly one status is the default.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **status** says where a ticket stands in its lifecycle. Statuses are defined per tenant and\nidentified by their `name`; `displayName` is the label meant for people and can be changed freely.\n\nExactly one status is the tenant's default — the one new tickets start in. `position` is the order\nthey are meant to be shown in.\n\nA ticket cannot move between arbitrary statuses: the permitted moves are defined as *Status\nTransitions*.\n","name":"ticket_status"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.ListTicketStatusesResponse-domain_TicketStatus":{"properties":{"count":{"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/domain.TicketStatus"},"type":"array","uniqueItems":false}},"type":"object"},"domain.TicketStatus":{"properties":{"allowedSourceStatuses":{"items":{"$ref":"#/components/schemas/domain.TicketStatus"},"type":"array","uniqueItems":false},"allowedTargetStatuses":{"items":{"$ref":"#/components/schemas/domain.TicketStatus"},"type":"array","uniqueItems":false},"color":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"displayName":{"type":"string"},"isDefault":{"type":"boolean"},"name":{"type":"string"},"position":{"type":"integer"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/ticket-statuses":{"get":{"description":"Returns the tenant's ticket statuses.\n\n**Filterable and sortable** — `name`, `displayName`, `color`, `isDefault`, `position`, `createdAt`,\n`updatedAt`.\n\n`position` is the order they are meant to be shown in, `isDefault` marks the status a new ticket\nstarts in. Exactly one status is the default.\n","operationId":"listTicketStatuses","parameters":[{"description":"JSON filter expression","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Free-text term — no effect here","in":"query","name":"search","schema":{"type":"string"}},{"description":"Comma-separated field:direction terms","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Selection of fields and relations","in":"query","name":"fields","schema":{"type":"string"}},{"description":"Number of entries to skip","in":"query","name":"offset","schema":{"default":0,"type":"integer"}},{"description":"Page size, 1 to 100","in":"query","name":"limit","schema":{"default":100,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ListTicketStatusesResponse-domain_TicketStatus"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"List ticket statuses","tags":["ticket_status"]}}}}
```
## Create a ticket status
> Creates a ticket status. \`name\` identifies it from then on and \`displayName\` is what people see.\
> \
> \`allowedSourceStatusNames\` and \`allowedTargetStatusNames\` create the transitions in the same request:\
> which statuses may lead into this one, and which ones it may lead to. Without them the new status is\
> reachable from nowhere.\
> \
> Setting \`isDefault\` makes this the status new tickets start in and takes that role away from the\
> status that held it.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **status** says where a ticket stands in its lifecycle. Statuses are defined per tenant and\nidentified by their `name`; `displayName` is the label meant for people and can be changed freely.\n\nExactly one status is the tenant's default — the one new tickets start in. `position` is the order\nthey are meant to be shown in.\n\nA ticket cannot move between arbitrary statuses: the permitted moves are defined as *Status\nTransitions*.\n","name":"ticket_status"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.AddTicketStatusRequest":{"properties":{"allowedSourceStatusNames":{"items":{"type":"string"},"type":"array","uniqueItems":false},"allowedTargetStatusNames":{"items":{"type":"string"},"type":"array","uniqueItems":false},"color":{"type":"string"},"displayName":{"type":"string"},"isDefault":{"type":"boolean"},"name":{"type":"string"},"position":{"type":"integer"}},"required":["displayName","name"],"type":"object"},"v1.AddTicketStatusResponse":{"properties":{"data":{"$ref":"#/components/schemas/domain.TicketStatus"}},"type":"object"},"domain.TicketStatus":{"properties":{"allowedSourceStatuses":{"items":{"$ref":"#/components/schemas/domain.TicketStatus"},"type":"array","uniqueItems":false},"allowedTargetStatuses":{"items":{"$ref":"#/components/schemas/domain.TicketStatus"},"type":"array","uniqueItems":false},"color":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"displayName":{"type":"string"},"isDefault":{"type":"boolean"},"name":{"type":"string"},"position":{"type":"integer"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/ticket-statuses":{"post":{"description":"Creates a ticket status. `name` identifies it from then on and `displayName` is what people see.\n\n`allowedSourceStatusNames` and `allowedTargetStatusNames` create the transitions in the same request:\nwhich statuses may lead into this one, and which ones it may lead to. Without them the new status is\nreachable from nowhere.\n\nSetting `isDefault` makes this the status new tickets start in and takes that role away from the\nstatus that held it.\n","operationId":"addTicketStatus","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.AddTicketStatusRequest","summary":"request","description":"Status to create"}]}}},"description":"Status to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.AddTicketStatusResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Create a ticket status","tags":["ticket_status"]}}}}
```
## Delete a ticket status
> Deletes a ticket status. Three cases are refused with \`400\`:\
> \
> \- the \*\*default\*\* status — assign a different default first,\
> \- the \*\*last remaining\*\* status,\
> \- a status \*\*still used by tickets\*\* without a \`migrationTargetName\`.\
> \
> When tickets still carry the status, \`migrationTargetName\` names the status they are moved to; it has\
> to differ from the one being deleted. The move and the deletion happen together, so no ticket is ever\
> left without a status.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **status** says where a ticket stands in its lifecycle. Statuses are defined per tenant and\nidentified by their `name`; `displayName` is the label meant for people and can be changed freely.\n\nExactly one status is the tenant's default — the one new tickets start in. `position` is the order\nthey are meant to be shown in.\n\nA ticket cannot move between arbitrary statuses: the permitted moves are defined as *Status\nTransitions*.\n","name":"ticket_status"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.DeleteTicketStatusRequest":{"properties":{"migrationTargetName":{"type":"string"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/ticket-statuses/{name}":{"delete":{"description":"Deletes a ticket status. Three cases are refused with `400`:\n\n- the **default** status — assign a different default first,\n- the **last remaining** status,\n- a status **still used by tickets** without a `migrationTargetName`.\n\nWhen tickets still carry the status, `migrationTargetName` names the status they are moved to; it has\nto differ from the one being deleted. The move and the deletion happen together, so no ticket is ever\nleft without a status.\n","operationId":"deleteTicketStatus","parameters":[{"description":"Status name","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.DeleteTicketStatusRequest","summary":"request","description":"Where to move tickets that still carry the status"}]}}},"description":"Where to move tickets that still carry the status"},"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Delete a ticket status","tags":["ticket_status"]}}}}
```
## Change a ticket status
> Changes a ticket status. The body follows JSON Merge Patch semantics: an absent field stays as it is,\
> \`null\` clears it, a value sets it. The \`name\` cannot be changed — it is the identifier tickets refer\
> to.\
> \
> Setting \`isDefault\` to \`true\` moves the default here and clears it on the status that held it.\
> Setting it to \`false\` on the current default is answered with \`400\`: a tenant always has exactly one\
> default, so assign a different one instead.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **status** says where a ticket stands in its lifecycle. Statuses are defined per tenant and\nidentified by their `name`; `displayName` is the label meant for people and can be changed freely.\n\nExactly one status is the tenant's default — the one new tickets start in. `position` is the order\nthey are meant to be shown in.\n\nA ticket cannot move between arbitrary statuses: the permitted moves are defined as *Status\nTransitions*.\n","name":"ticket_status"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.PatchTicketStatusRequest":{"properties":{"color":{"type":"string"},"displayName":{"type":"string"},"isDefault":{"type":"boolean"},"position":{"type":"integer"}},"type":"object"},"v1.PatchTicketStatusResponse":{"properties":{"data":{"$ref":"#/components/schemas/domain.TicketStatus"}},"type":"object"},"domain.TicketStatus":{"properties":{"allowedSourceStatuses":{"items":{"$ref":"#/components/schemas/domain.TicketStatus"},"type":"array","uniqueItems":false},"allowedTargetStatuses":{"items":{"$ref":"#/components/schemas/domain.TicketStatus"},"type":"array","uniqueItems":false},"color":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"displayName":{"type":"string"},"isDefault":{"type":"boolean"},"name":{"type":"string"},"position":{"type":"integer"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/ticket-statuses/{name}":{"patch":{"description":"Changes a ticket status. The body follows JSON Merge Patch semantics: an absent field stays as it is,\n`null` clears it, a value sets it. The `name` cannot be changed — it is the identifier tickets refer\nto.\n\nSetting `isDefault` to `true` moves the default here and clears it on the status that held it.\nSetting it to `false` on the current default is answered with `400`: a tenant always has exactly one\ndefault, so assign a different one instead.\n","operationId":"patchTicketStatus","parameters":[{"description":"Status name","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.PatchTicketStatusRequest","summary":"request","description":"Fields to change"}]}}},"description":"Fields to change","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.PatchTicketStatusResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Change a ticket status","tags":["ticket_status"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://hub.equipme.io/development/api-reference-app/ticket-status.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.