> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get all service ticket states > Get all service ticket states in the system. ## OpenAPI ````json GET /api/v1/maintenance/servicetickets/states { "openapi": "3.0.4", "info": { "title": "Maintenance V1", "description": "# Maintenance API Documentation\nWelcome to BETA version of the new Maintenance API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.\n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## Operations \n\nThe API supports operations for the following: \n\n- **Service Tickets**\n\nFor each type, you can: \n\n- **GET**: Retrieve a list or apply filters.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Metadata" }, { "name": "ServiceTickets" } ], "paths": { "/api/v1/maintenance/servicetickets/states": { "get": { "tags": [ "Admin" ], "summary": "Get all service ticket states", "description": "Get all service ticket states in the system.", "operationId": "GetServiceTicketStates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketState" } } } } } }, "x-d360-narrative-url": "

Get all service ticket states

This endpoint retrieves the list of states available for service tickets.

Integrators call this endpoint before creating or updating a ticket, to know which state names are currently configured, since the list is managed in the Bloxs application and can change over time.


Request Fields

This endpoint takes no request parameters.


Response Fields

Field

Type

Required

Description

name

string

Yes

Name of the state. Values are configurable in the Bloxs application and cannot be managed through the API. Maximum length 256 characters.

systemState

integer

No

System state linked to this state. Valid values are 1 (Active), 2 (OnHold), 3 (SignedOff), or 4 (Done). Only populated for Bloxs' default states; for custom states created by the user, this is null. The system state can trigger certain actions, for example sending a reminder when a state is set to OnHold, which the user has limited control over.

" } } }, "components": { "schemas": { "ServiceTicketState": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 0, "type": "string" }, "systemState": { "type": "integer", "description": "Active = 1\nOnHold = 2\nSignedOff = 3\nDone = 4", "format": "int32", "nullable": true, "x-enumNames": [ "Active", "OnHold", "SignedOff", "Done" ] } }, "additionalProperties": false } } } } ````