Tickets

Refresh

Returns the tickets created, updated or deleted since the list call that issued refresh_key, together with a new refresh_key for the next poll (an expired key is flagged in the response, and the list then has to be fetched again).

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/tickets/refresh

Authorisation: Minimum role: USER

Request arguments

Name	Type	Source
refresh_key	String	Query

Request body example

Response

Status: 200 (OK)
Type: DTO_refreshed_tickets

Wrapper: DTO_response_wrap

Other statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

DTO_refreshed_tickets

Name	Type	Description
new_tickets	Object	New tickets
updated_tickets	Object	Updated tickets
deleted_ticket_ids	Int32[]	Deleted ticket ids
refresh_key	String	Refresh key
refresh_expired	Boolean	True when the server-side refresh data behind the supplied refresh_key no longer exists (it has a limited TTL). The client's snapshot is too old to diff against — refetch the list to get current data and a fresh refresh_key.

Generated Aug 4, 2026 18:37