Tickets

Search tickets

Search for one or more tickets.

get/v1/Tickets

Request

Query parameters

search.ticket_idinteger[]

Query by ticket identifier.

search.descriptionstring[]

Query by ticket description.

search.created_date_startstring date-time

Return entries created after this date.

search.created_date_endstring date-time

Return entries created before this date.

search.customer_idinteger[]

Query by ticket customer identifier.

search.resolutionstring[]

Query by ticket resolution.

search.ticket_type_idinteger[]

Query by ticket type identifier.

search.ticket_step_idinteger[]

Query by ticket step identifier.

search.assigned_user_idinteger[]

Query by assigned user identifier.

search.assigned_group_idinteger[]

Query by assigned group identifier.

search.prioritystring[]

Query by priority.

search.contact_namestring[]

Query by contact name.

search.contact_phonestring[]

Query by contact phone.

search.contact_emailstring[]

Query by contact email.

search.additional_contact_emailsstring

Additional contact email addresses associated with a specific ticket.

search.admin_ccsstring

Admin CCs associated with a specific ticket.

search.custom_statusstring[]

Query by custom status.

search.created_byinteger[]

Query by created by.

search.due_date_startstring date-time

Return only entries with due dates after this date.

search.due_date_endstring date-time

Return only entries with due dates before this date.

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

Query by status.

search.modified_date_startstring date-time

Return only entries modified after this date.

search.modified_date_endstring date-time

Return only entries modified before this date.

search.modified_byinteger[]

Query by modified by.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

No recorded changes to this operation across all 2 revisions of this API.