Skip to main content
GET
Retrieve custom preset filter

Authorizations

X-Initdesk-Token
string
header
required

Path Parameters

id
string
required
organization_id
string
required
Pattern: ^[-a-zA-Z0-9_]+$

Response

200 - application/json

Serializer for creating and updating custom preset filters.

Seeded defaults may carry an internal key (never exposed here). When key is set, name in the response is translated via gettext for the request locale. Providing name on update clears key so the stored name becomes user-owned data (translate-until-renamed).

id
string<uuid>
required
read-only
name
string
required
Maximum string length: 255
criteria
object
required

Structured ticket search criteria for custom preset filters.

created_by
object
required

Read-only creator summary for custom preset filter responses.

created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
position
integer

Display order within the visibility band (lower first). Personal and organization-shared filters are ordered in separate bands.

Required range: 0 <= x <= 2147483647
display_count
boolean

Whether the inbox UI should show a ticket count for this filter.

visibility
enum<string>
  • personal - Personal
  • organization_shared - Organization shared
Available options:
personal,
organization_shared