Filters

This method will return all the filters which are configured within your account.

URL

/api/v2/objects/filters

Access

When authenticated with a account token, all filters will be returned however when authenticated with a user token only filters which the authenticated user has access to will be returned.

Supported Parameters

user - if a username or ID of a user is passed here, a count variable will be included with the filter data which includes the number of tickets in the filter. If authenticated with a user token, the count will be included, the user variable has no effect with this authentication.

Example JSON

[
  {
    "id": 1,
    "name": "My Teams' Tickets",
    "description": "Display all open tickets which are assigned to my team",
    "icon": 5,
    "order": "desc",
    "sort": "updated_at",
    "conditions": {
      "all": [
        {
          "var": "team",
          "operator": "equal",
          "data": "{{assigned_teams}}"
        }
      ],
      "any": [
        {
          "var": "status",
          "operator": "equal",
          "data": "1"
        },
        {
          "var": "status",
          "operator": "equal",
          "data": "2"
        }
      ]
    },
    "cols": [
      "status",
      "details",
      "customer",
      "priority",
      "updated_at"
    ]
  },
  {
    "id": 2,
    "name": "My Open Tickets",
    "description": "Display all tickets which are assigned to me and pending a response",
    "icon": 2,
    "order": "desc",
    "sort": "updated_at",
    "conditions": {
      "all": [
        {
          "var": "status_type",
          "operator": "equal",
          "data": "0"
        },
        {
          "var": "user",
          "operator": "equal",
          "data": "{{current_user}}"
        }
      ],
      "any": [

      ]
    },
    "cols": [
      "status",
      "details",
      "customer",
      "priority",
      "updated_at"
    ]
  },
  {
    "id": 3,
    "name": "Overdue Tickets",
    "description": "Display all tickets which are currently overdue",
    "icon": 3,
    "order": "asc",
    "sort": "reply_due_at",
    "conditions": {
      "all": [
        {
          "var": "team",
          "operator": "equal",
          "data": "{{assigned_teams}}"
        }
      ],
      "any": [
        {
          "var": "reply_late_time",
          "operator": "lt",
          "data": "0"
        },
        {
          "var": "resolution_late_time",
          "operator": "lt",
          "data": "0"
        }
      ]
    },
    "cols": [
      "status",
      "subject",
      "customer",
      "team",
      "user",
      "reply_due_at",
      "resolution_due_at"
    ]
  },
  {
    "id": 4,
    "name": "Pending Tickets",
    "description": "Display all tickets which are currently pending a response from a customer and assigned to one of your teams",
    "icon": 4,
    "order": "desc",
    "sort": "updated_at",
    "conditions": {
      "all": [
        {
          "var": "status",
          "operator": "equal",
          "data": "3"
        },
        {
          "var": "team",
          "operator": "equal",
          "data": "{{assigned_teams}}"
        }
      ],
      "any": [

      ]
    },
    "cols": [
      "status",
      "subject",
      "customer",
      "priority",
      "updated_at"
    ]
  },
  {
    "id": 5,
    "name": "All Tickets",
    "description": "Display all tickets which are assigned to one of my teams",
    "icon": 22,
    "order": "desc",
    "sort": "updated_at",
    "conditions": {
      "all": [
        {
          "var": "team",
          "operator": "equal",
          "data": "{{assigned_teams}}"
        }
      ],
      "any": [

      ]
    },
    "cols": [
      "status",
      "subject",
      "customer",
      "priority",
      "updated_at"
    ]
  },
  {
    "id": 6,
    "name": "Resolved Tickets",
    "description": "Display all tickets which are ",
    "icon": 6,
    "order": "desc",
    "sort": "updated_at",
    "conditions": {
      "all": [
        {
          "var": "status_type",
          "operator": "equal",
          "data": "1"
        },
        {
          "var": "team",
          "operator": "equal",
          "data": "{{assigned_teams}}"
        }
      ],
      "any": [

      ]
    },
    "cols": [
      "status",
      "subject",
      "customer",
      "priority",
      "updated_at"
    ]
  }
]