v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Tickets

View ticket

Find a single ticket by ID.

get/v1/Tickets/{id}

Path parameters

idinteger required

Format - int32. ID of the ticket to view.

Response

OK

okboolean
ticket_idinteger

Primary identifier for this ticket.

descriptionstring

Description of the issue.

status'OPEN' | 'INWORK' | 'CLOSED' | 'PENDING_CANCELLATION' | 'CANCELED' | 'PENDING_CLOSE' | 'PENDING'

Current status of the ticket.

resolutionstring

Explanation of how the issue was resolved.

ticket_type_idinteger

Foreign identifier indicating the type of ticket.

ticket_step_idinteger

Foreign identifier indicating the step being performed to solve the issue.

assigned_user_idinteger

Foreign identifier indicating the user who is assigned to this ticket.

assigned_group_idinteger

Foreign identifier indicating the group who is assigned to this ticket.

customer_idinteger

Foreign identifier indicating the customer who has the issue. Can be set to 0 (zero) or omitted to indicate ticket is not linked to an account.

service_idinteger

Foreign identifier indicating the associated line of service. Can be set to 0 (zero) or omitted to indicate ticket is not linked to a service.

priority_idinteger

Foreign identifier indicating the priority given to this ticket.

contact_namestring

Name of the primary contact on the customer side.

contact_phonestring

Phone number of the primary contact.

contact_emailstring

Primary contact email (or emails separated by comma).

additional_contact_emailsstring

Additional contact email addresses associated with a specific ticket.

admin_ccsstring

Admin CCs associated with a specific ticket.

custom_statusstring

An open field to hold your own status code.

due_datestring date-time

Due date for ticket resolution.

created_datestring date-time

Date and time this ticket was created.

closed_datestring date-time

Date and time this ticket was closed.

created_byinteger

Foreign identifier indicating the user who created this ticket.

modified_datestring date-time

Date and time this ticket was modified.

modified_byinteger

Foreign identifier indicating the user who last modified this ticket.

process_idinteger

Foreign identifier indicating what process to start with the ticket.

contact_idinteger

Foreign identifier indicating which contact is associated with this ticket.

provider_ticket_numberstring

The provider ticket number associated with this ticket, if applicable.

provider_contact_IDinteger

Foreign identifier indicating which provider contact is associated with this ticket.

process_phase_idinteger

Foreign identifier indicating which phase of the current process this ticket is in.

creation_sourcestring

Enumerated value indicating creation source of ticket (Rev.io, Agent Portal, etc.).