Support

Retrieve a Ticket

Work with Tickets.Retrieves the Ticket with the given ID.

get/admin/support/tickets/{id}

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/support/tickets/{id}
Auth: HTTP basic

Path parameters

idnumber double required

Example:1

The ID of the desired Ticket.

Response

customer_idnumber

Customer ID

incoming_customer_idnumber

Incoming customer ID

reporter_idnumber

reporter_type'admin' | 'customer' | 'api' | 'incoming' | 'none'

Type of the reporter

hiddenboolean

Is ticket hidden for customer

assign_tonumber

Admin ID to be assigned a ticket

status_idnumber

Ticket status ID

group_idnumber

Ticket group ID

type_idnumber required

Ticket type ID

task_idnumber

subjectstring required

Ticket subject

prioritystring required

Ticket priority. Values: 'low', 'medium', 'high', 'urgent'

starboolean

Is ticket starred

unread_by_customerboolean

Is ticket unread by customer

unread_by_adminboolean

Is ticket unread by administrator

closedboolean

Is ticket closed

created_atstring

Ticket creating datetime

updated_atstring

Ticket updating datetime

source'administration' | 'api' | 'portal' | 'widget' | 'incoming'

Origin of the ticket

trashnumber

shareablenumber

notestring

watchingnumber

related_account_idnumber

ID of the related account. Typically a sub-account, but can also be the main account if the ticket is created directly for it.

related_account_type'none'

Type of the related account + Members + none + main + sub

hidden_from_related_accountnumber

If set to 1, the ticket is hidden from the account specified in related_account_id. Value can be 0 (visible) or 1 (hidden)

unread_by_related_accountnumber

Indicates whether the account in related_account_id has unread messages in the ticket. Value can be 0 (read) or 1 (unread).

idnumber

Ticket ID

Example response

{
  "customer_id": 1,
  "incoming_customer_id": 2,
  "reporter_id": 1,
  "reporter_type": "admin",
  "hidden": false,
  "assign_to": 0,
  "status_id": 1,
  "group_id": 3,
  "type_id": 2,
  "task_id": 1,
  "subject": "Ticket subject",
  "priority": "medium",
  "star": false,
  "unread_by_customer": false,
  "unread_by_admin": false,
  "closed": false,
  "created_at": "2018-11-09 10:28:34",
  "updated_at": "2018-12-12 14:22:49",
  "source": "administration",
  "trash": 0,
  "shareable": 1,
  "note": "Note message",
  "watching": 1,
  "related_account_id": 0,
  "related_account_type": "none",
  "hidden_from_related_account": 0,
  "unread_by_related_account": 1,
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.