GET/desk/api/v2/search/filters/{collection}/{id}.json
Get a single search filter by id.
The following values are allowed in the includes query parameter:
- users
- all
Path Params
- Name
id
- Type
- integer
- required
- Description
- Name
collection
- Type
- integer
- required
- Description
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
SearchFilterAPIBody handles the get/create/update request/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.
200 OK
SearchFilterAPIBody
{
"filter": {
"collection": "string",
"conditions": "string",
"createdAt": "2024-12-04T16:23:03.839Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"deletedAt": "2024-12-04T16:23:03.839Z",
"deletedBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"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-12-04T16:23:03.839Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
}
},
"included": {
"users": [
{
"autoFollowOnCC": true,
"avatarURL": "string",
"createdAt": "2024-12-04T16:23:03.839Z",
"createdBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"deletedAt": "2024-12-04T16:23:03.839Z",
"deletedBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"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": {
"additionalProp": "Unknown Type: any"
},
"type": 0
},
"updatedAt": "2024-12-04T16:23:03.839Z",
"updatedBy": {
"delete": true,
"id": 0,
"meta": {
"additionalProp": "Unknown Type: any"
},
"type": 0
}
}
]
}
}