Awesome Support Developer Documentation

List Tickets

Arguments

context Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit
page Current page of the collection.

Default: 1
per_page Maximum number of items to be returned in result set.

Default: 10
search Limit results to those matching a string.
after Limit response to posts published after a given ISO8601 compliant date.
before Limit response to posts published before a given ISO8601 compliant date.
exclude Ensure result set excludes specific IDs.

Default:

include Limit result set to specific IDs.

Default:

offset Offset the result set by a specific number of items.
order Order sort attribute ascending or descending.

Default: desc

One of: asc, desc
orderby Sort collection by object attribute.

Default: date

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title
slug Limit result set to posts with one or more specific slugs.
status Limit result set to items assigned one or more statuses.

Default: any
ticket-tag Limit result set to all items that have the specified term assigned in the ticket-tag taxonomy.

Default:

ticket-tag_exclude Limit result set to all items except those that have the specified term assigned in the ticket-tag taxonomy.

Default:

product Limit result set to all items that have the specified term assigned in the product taxonomy.

Default:

product_exclude Limit result set to all items except those that have the specified term assigned in the product taxonomy.

Default:

department Limit result set to all items that have the specified term assigned in the department taxonomy.

Default:

department_exclude Limit result set to all items except those that have the specified term assigned in the department taxonomy.

Default:

ticket_priority Limit result set to all items that have the specified term assigned in the ticket_priority taxonomy.

Default:

ticket_priority_exclude Limit result set to all items except those that have the specified term assigned in the ticket_priority taxonomy.

Default:

ticket_channel Limit result set to all items that have the specified term assigned in the ticket_channel taxonomy.

Default:

ticket_channel_exclude Limit result set to all items except those that have the specified term assigned in the ticket_channel taxonomy.

Default:

state Limit result set to tickets in the specified state.

Default: open
author The ID for the author of the object. Set to 0 for all authors.

Default: The ID of the current logged in client if applicable.
assignee The agent assigned to this ticket. Set to 0 for all assignees.

Default: The ID of the current logged in agent if applicable.

Definition

GET /wpas-api/v1/tickets

Example Request

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

Share: