Awesome Support Developer Documentation

Tickets: Schema

The schema defines all the fields that exist for a ticket object.

date
string, datetime (ISO8601)
The date the object was published, in the site’s timezone.

Context: view, edit, embed

date_gmt
string, datetime (ISO8601)
The date the object was published, as GMT.

Context: view, edit

guid
object
The globally unique identifier for the object.

Read only

Context: view, edit

id
integer
Unique identifier for the object.

Read only

Context: view, edit, embed

modified
string, datetime (ISO8601)
The date the object was last modified, in the site’s timezone.

Read only

Context: view, edit

modified_gmt
string, datetime (ISO8601)
The date the object was last modified, as GMT.

Read only

Context: view, edit

slug
string
An alphanumeric identifier for the object unique to its type.

Context: view, edit, embed

status
string
A named status for the object.

Context: view, edit

One of: publish, future, draft, pending, private, in-progress, failed, wc-active, wc-switched, wc-expired, wc-pending-cancel, wc-pending, wc-processing, wc-on-hold, wc-completed, wc-cancelled, wc-refunded, wc-failed, queued, processing, hold, read, unread, wcm-active, wcm-free_trial, wcm-delayed, wcm-complimentary, wcm-pending, wcm-paused, wcm-expired, wcm-cancelled

type
string
Type of Post for the object.

Read only

Context: view, edit, embed

title
object
The title for the object.

Context: view, edit, embed

content
object
The content for the object.

Context: view, edit

ticket-tag
array
The terms assigned to the object in the ticket-tag taxonomy.

Context: view, edit

product
string
The terms assigned to the object in the product taxonomy.

Context: view, edit

department
string
The terms assigned to the object in the department taxonomy.

Context: view, edit

ticket_priority
string
The terms assigned to the object in the ticket_priority taxonomy.

Context: view, edit

ticket_channel
string
The terms assigned to the object in the ticket_channel taxonomy.

Context: view, edit

state
string
Limit result set to tickets in the specified state.

Context:

author
integer
The ID for the author of the object. Set to 0 for all authors.

Context: view, edit, embed

assignee
integer
The agent assigned to this ticket. Set to 0 for all assignees.

Context: view, edit, embed

secondary-assignee
integer
The secondary assignee for this ticket

Context: view, edit

tertiary-assignee
integer
The tertiary assignee for this ticket

Context: view, edit

customer-reply-count
integer
The number of customer replies to this ticket

Context: view, edit

agent-reply-count
integer
The number of agent replies to this ticket

Context: view, edit

total-reply-count
integer
The number of total replies to this ticket

Context: view, edit

time-calculated
integer
The gross time calculated for ticket in minutes

Context: view, edit

time-adjustments
integer
The time adjustments for ticket in minutes

Context: view, edit

time-final
integer
The final adjusted time for ticket in minutes

Read only

Context: view, edit

time-adjustments-type
string
The type of time adjustment, positive or negative.

Context: view, edit

time-notes
string
The notes for the time

Context: view, edit


Example Request

$ curl -X OPTIONS -i http://demo.getawesomesupport.com/wp-json/wpas-api/v1/tickets

Share: