Returns all saved searches that the user has access to

Prev Next
Get
/saved-searches

Get a list of SavedSearches.

Security
OAuth

Laravel passport oauth2 security.

FlowAuthorization Code
Authorization URLhttps://develop-qa.processmaker.net/oauth/authorize
Token URLhttps://develop-qa.processmaker.net/oauth/token
Refresh URLhttps://develop-qa.processmaker.net/token/refresh
Query parameters
filter
string

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

type
string

Only return saved searches by type

Valid values[ "request", "task", "collection" ]
subset
string

Only return saved searches that are yours or those that have been shared with you

Valid values[ "mine", "shared" ]
order_by
string

Field to order results by

order_direction
string
Valid values[ "asc", "desc" ]
Default"asc"
per_page
integer
Default10
include
string

Include data from related models in payload. Comma separated list.

Default""
Responses
200

list of saved searches

Expand All
object
data
Array of object (SavedSearch)
object
id
string (id)
user_id
string (id)
created_at
string (date-time)
updated_at
string (date-time)
meta
object

Represents an Eloquent model of a Saved Search.

pmql
string
title
string
type
string
Valid values[ "task", "request" ]
advanced_filter
object
meta
object
filter
string
sort_by
string
sort_order
string
Valid values[ "asc", "desc" ]
count
integer
total_pages
integer
current_page
integer
form
integer
last_page
integer
path
string
per_page
integer
to
integer
total
integer