Create filter view

Creates a new filter view (saved filter configuration).

The created view is automatically owned by the authenticated user.

Body Fields

FieldTypeRequiredDescription
labelstringYesView display name
scopestringYesEntity scope (see Scopes below)
sharebooleanYesWhether to share with other users
favoritebooleanYesMark as favorite
columnsarrayNoList of column names to display
filtersobjectNoFilter criteria (see Filters below)
sortstringNoField name to sort by
directionstringNoSort direction: asc or desc

Scopes

ScopeDescription
dealsDeals/opportunities list
customersCustomers/contacts list
quotationsQuotations list
productsProducts catalog

Filters Object

Filter criteria use field names as keys with operator objects:

{
  "fieldName": {
    "eq": "exact value",
    "gte": 100,
    "lte": 500,
    "like": "partial"
  }
}

Response Fields

FieldTypeDescription
idintegerNewly created filter view unique identifier
labelstringView display name
scopestringEntity scope
sharebooleanShared status
favoritebooleanFavorite status
columnsarrayColumn configuration
filtersobjectFilter criteria
sortstringSort field
directionstringSort direction
ownerobjectView owner (current user)
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 201 Created: Filter view successfully created
  • 400 Bad Request: Invalid request body or validation error
  • 401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
boolean
boolean
columns
array of strings
columns
filters
object
string
string
Responses
201

Resource created

400

Bad request

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!