Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Get ticket by id

Prev Next
Get
/inventory/tickets/{ticketId}

Returns the ticket for the given id.

Required permissions: READ_TICKET.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
ticketId
string

Condition on ticket id.

Exampleabcd1234
Responses
200

Successful operation.

Expand All
object

Represents a support or maintenance ticket associated with a specific asset (thing), tracking its lifecycle from creation to resolution.

id
string

Unique identifier of the ticket, assigned by the system at creation.

Example69cd430d90379a1f9604cca0
code
string

Human-readable ticket code, auto-generated and unique within the tenant (e.g. TKT-000002).

ExampleTKT-000002
organizationId
string

ID of the organization currently responsible for managing this ticket.

Example661533adc04f90248aa739a2
responsibileName
string

Display name of the organization responsible for this ticket.

ExampleACME
creationOrganizationId
string

ID of the organization that originally created the ticket. May differ from organizationId if responsibility was transferred.

Example661533adc04f90248aa739a2
creationUserId
string

ID of the user who created the ticket.

Example69cd30c0619a917c2d416b78
thingId
string

ID of the asset (thing) this ticket is associated with.

Example661fabf042541977c4ff380c
title
string

Short descriptive title of the ticket, provided by the creator.

Exampletest2
typeId
string

ID of the ticket type definition that classifies this ticket (e.g. fault report, maintenance request).

Example69cce8e238f8146af79b66df
type
object (TicketType)

Defines the classification of a ticket, determining its purpose and behavior (e.g. fault report, inspection, maintenance request).

id
string

Unique identifier of the ticket type.

Example69cce8e238f8146af79b66df
name
string

Internal machine-readable name of the ticket type.

Exampleissue_report
label
string

Human-readable label of the ticket type, suitable for display in the UI.

ExampleFault/Anomaly Report
status
string

Lifecycle status of a ticket: - OPEN: ticket created but not yet being worked on. - IN_PROGRESS: ticket is actively being handled. - ON_HOLD: work is paused, waiting for external input or conditions. - RESOLVED: the issue has been fixed. - REJECTED: ticket was dismissed without resolution.

Valid values[ "OPEN", "IN_PROGRESS", "ON_HOLD", "RESOLVED", "REJECTED" ]
ExampleIN_PROGRESS
creationTimestamp
integer (int64)

Unix timestamp in milliseconds representing when the ticket was created.

Example1775059725671
assigneeUserId
string | null

ID of the user currently assigned to handle this ticket. Null if the ticket is unassigned.

Example6a058e933082730da608263c
items
Array of object (TicketItem)

Ordered list of activity entries representing the full audit trail of the ticket (status changes, notes, attachments).

object

A single audit trail entry recording an action performed on the ticket, such as a status transition, a note left by a user, or a file attachment.

timestamp
integer (int64)

Unix timestamp in milliseconds of when this item was recorded.

Example1777301746141
userId
string

ID of the user who performed the action recorded by this item.

Example69ef57196e9f727fab42fcab
type
string

Lifecycle status of a ticket: - OPEN: ticket created but not yet being worked on. - IN_PROGRESS: ticket is actively being handled. - ON_HOLD: work is paused, waiting for external input or conditions. - RESOLVED: the issue has been fixed. - REJECTED: ticket was dismissed without resolution.

Valid values[ "OPEN", "IN_PROGRESS", "ON_HOLD", "RESOLVED", "REJECTED" ]
ExampleIN_PROGRESS
statusChange
object (TicketStatusChange)

Records a status transition on a ticket, capturing both the previous and the new status.

from
string

Lifecycle status of a ticket: - OPEN: ticket created but not yet being worked on. - IN_PROGRESS: ticket is actively being handled. - ON_HOLD: work is paused, waiting for external input or conditions. - RESOLVED: the issue has been fixed. - REJECTED: ticket was dismissed without resolution.

Valid values[ "OPEN", "IN_PROGRESS", "ON_HOLD", "RESOLVED", "REJECTED" ]
ExampleIN_PROGRESS
to
string

Lifecycle status of a ticket: - OPEN: ticket created but not yet being worked on. - IN_PROGRESS: ticket is actively being handled. - ON_HOLD: work is paused, waiting for external input or conditions. - RESOLVED: the issue has been fixed. - REJECTED: ticket was dismissed without resolution.

Valid values[ "OPEN", "IN_PROGRESS", "ON_HOLD", "RESOLVED", "REJECTED" ]
ExampleIN_PROGRESS
note
string | null

Free-text note content. Populated only when type is NOTE, null otherwise.

attachment

Attached file object. Populated only when type is ATTACHMENT, null otherwise.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error