Ticket Details

GET/api/v1/tickets/{ticket_id}TechExpress

Returns the ticket details for the specified ticket_id.

Auth Scope

urn:grt:techexpress

Content-Type

application/json

Rate Limit

60 req/min

Headers

Header	Value
`Authorization`	`Bearer access-token`

Path Parameters

Parameter	Type	Required	Description
`ticket_id`	integer	Yes	Ticket ID provided in POST ticket response

Query Parameters

Parameter	Type	Required	Description
`granted_tenant_macnum`	string	No	The company macnum on whose behalf the action is performed

Response

Success Response (200 OK)

Response Fields

Field	Type	Description
`account_id`	integer	Id of an account ticket was created under
`address_1`	string	The primary street address for the location associated with this ticket
`attachments`	array of objects	A list detailing files that have been attached to this ticket. Each object contains `filename` (string) and `id` (integer)
`automatic_email_cc`	boolean	Indicates whether an automated email CC notification is sent for updates related to this ticket
`automatic_email_cc_address`	string	The email address(es) that receive automated CC notifications for this ticket
`automatic_email_contact`	boolean	Indicates whether an automated email notification is sent to the primary contact for this ticket
`board_name`	string	The name of the service board or queue to which this ticket is assigned
`category`	string	The category or status classification of the ticket within its board (e.g., "Active")
`city`	string	The city component of the address associated with the ticket's location
`company_id`	integer	The unique identifier of the company that the ticket is associated with
`company_identifier`	string	An internal or external identifier used for the associated company
`company_name`	string	The full name of the company associated with the ticket (e.g., "Valvoline")
`contact_email_address`	string	The primary email address of the contact person for this ticket
`customer_preferred_tech`	boolean	Indicates if the customer has requested a specific technician for the service
`customer_ticket_number`	string	A reference ticket number provided by the customer for their own tracking
`date_entered`	string (ISO 8601 UTC datetime)	The timestamp indicating when the ticket was initially created or entered into the system
`date_resolved`	string (ISO 8601 UTC datetime, or null)	The timestamp indicating when the ticket was resolved. It will be null if the ticket is not yet resolved
`id`	integer	The unique identifier of this ticket within the system
`initial_description`	string	A detailed initial description of the issue or service request
`last_updated`	string (ISO 8601 UTC datetime)	The timestamp indicating the last time any changes were made to this ticket record
`local_contact_name`	string	The name of the primary contact person physically located at the service site
`local_contact_number`	integer	The phone number of the primary local contact
`location_contact_email`	string	The email address of the primary local contact
`location_contact_ext`	string	The phone extension for the primary local contact
`location_name`	string	A specific name or description for the physical location related to the ticket (e.g., "Secret place")
`location_number`	string	A specific number or identifier for the location
`non_standard_tools`	string	A description of any non-standard tools or equipment required for the service
`po_number`	string	The Purchase Order number linked to this ticket
`prior_ticket`	integer	The ID of a previously created or related ticket
`priority`	string	The urgency level assigned to the ticket (e.g., "Priority 1", "Priority 3")
`schedule`	object	Contains details related to the ticket's scheduled time. Required field containing `end_date` (string, ISO 8601 UTC datetime), `id` (integer), `scheduling_type` (string), and `start_date` (string, ISO 8601 UTC datetime)
`secondary_lcon_email`	string or null	The email address of a secondary local contact person
`secondary_lcon_ext`	string or null	The phone extension of a secondary local contact person
`secondary_lcon_name`	string or null	The name of a secondary local contact person
`secondary_lcon_number`	string or null	The phone number of a secondary local contact person
`service_type`	string	The overarching type of service or work being requested for the ticket (e.g., "Site Audit", "Installation", "Repair")
`site_name`	string	Account macnum + some address information
`special_instructions`	string	Any specific instructions for the technician or for handling the ticket, such as access codes or call-ahead requirements
`state_identifier`	string	The two-letter state code for the location (e.g., "CA")
`status_name`	string	The current human-readable status of the ticket within its workflow (e.g., "Pending Tech Assignment")
`sub_type`	string	The subtype classification of the ticket
`summary`	string	A brief, high-level summary
`technician_id`	integer or null	The unique ID of the technician currently assigned to the ticket. It will be null if no technician is assigned
`technician_name`	string or null	The name of the technician currently assigned to the ticket. It will be null if no technician is assigned
`technician_phone_number`	string or null	The phone number of the technician currently assigned to the ticket. It will be null if no technician is assigned
`type_name`	string	The type name classification of the ticket
`zip`	string	The postal code (zip code) component of the address associated with the ticket's location

Code Examples

Errors

HTTP Status	Error Description	Resolution
`401`	Authentication Failed	Verify your access token is valid and included in the Authorization header with the "Bearer " prefix.
`403`	Permission Denied	Your access token does not have the required scope (`urn:grt:techexpress`). Contact your administrator to request the appropriate permissions.
`404`	Not Found	The specified ticket ID does not exist or you do not have access to it.