GET/desk/api/v2/search/filters/{collection}.json

Get a paginated list of search filters.

The following values are allowed in the filter query parameter:

id
name
description
collection
conditions
isShared
createdAt
updatedAt
deletedAt
createdBy
updatedBy
deletedBy
state

The following values are allowed in the orderBy query parameter:

id
name
description
collection
conditions
isShared
createdAt
updatedAt
deletedAt
createdBy
updatedBy
deletedBy
state
name
collection

Path Params

Name
collection
Type
integer
required
Description

Responses

Code
200
Type
object
Schema
Description
200 OK
SearchFiltersAPIBody handles the listing response for filters.
Code
304
Description
304 Not Modified No Data
Code
400
Type
object
Schema
Description
400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

SearchFiltersAPIBody

{
  "filters": [
    {
      "collection": "string",
      "conditions": "string",
      "createdAt": "2024-07-26T20:26:10.533Z",
      "createdBy": {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      },
      "deletedAt": "2024-07-26T20:26:10.533Z",
      "deletedBy": {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      },
      "description": "string",
      "filter_args": {
        "aggregate": {
          "Distinct": true,
          "Field": "string",
          "Operation": "string"
        },
        "bulkDryExecute": true,
        "fields": [
          "string"
        ],
        "filter": [
          "string"
        ],
        "id": 0,
        "ids": [
          0
        ],
        "includes": [
          "string"
        ],
        "orderBy": "string",
        "orderMode": "asc",
        "page": 0,
        "pageOffset": 0,
        "pageSize": 0,
        "skipAggregation": true
      },
      "id": 0,
      "isShared": true,
      "name": "string",
      "state": "string",
      "updatedAt": "2024-07-26T20:26:10.533Z",
      "updatedBy": {
        "delete": true,
        "id": 0,
        "meta": {},
        "type": 0
      }
    }
  ],
  "included": {
    "users": [
      {
        "autoFollowOnCC": true,
        "avatarURL": "string",
        "createdAt": "2024-07-26T20:26:10.533Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-07-26T20:26:10.533Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "editMethod": "string",
        "email": "string",
        "filter_args": {
          "aggregate": {
            "Distinct": true,
            "Field": "string",
            "Operation": "string"
          },
          "bulkDryExecute": true,
          "fields": [
            "string"
          ],
          "filter": [
            "string"
          ],
          "id": 0,
          "ids": [
            0
          ],
          "includes": [
            "string"
          ],
          "orderBy": "string",
          "orderMode": "asc",
          "page": 0,
          "pageOffset": 0,
          "pageSize": 0,
          "skipAggregation": true
        },
        "firstName": "string",
        "id": 0,
        "isAppOwner": true,
        "isPartTime": true,
        "lastName": "string",
        "ldKey": "string",
        "onboarding": {
          "addedFirstInbox": true,
          "bookmarkPage": true,
          "checkDeskHelpSite": true,
          "checkSampleInbox": true,
          "dismissedWelcome": true,
          "exploreHelpsites": true,
          "exploreReports": true,
          "inviteTeam": true,
          "repliedToFirstTicket": true,
          "reviewedCompanySettings": true,
          "reviewedProfile": true
        },
        "projectsCompanyId": 0,
        "reviewer": true,
        "role": "string",
        "sendPushNotifications": true,
        "sendWebNotifications": true,
        "state": "string",
        "ticketReplyRedirect": "string",
        "timeFormatId": 0,
        "timezoneId": 0,
        "trainingWheelsEnrollment": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "updatedAt": "2024-07-26T20:26:10.533Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        }
      }
    ]
  },
  "meta": {
    "page": {
      "count": 0,
      "hasMore": true,
      "hasMorePages": true,
      "page": 0,
      "pageOffset": 0,
      "pageSize": 0,
      "pages": 0,
      "records": 0
    }
  },
  "pagination": {
    "count": 0,
    "hasMore": true,
    "hasMorePages": true,
    "page": 0,
    "pageOffset": 0,
    "pageSize": 0,
    "pages": 0,
    "records": 0
  }
}

Download Swagger