Skip to main content
GET
List award saved searches

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string
perPage
integer
default:25
Required range: x <= 100
active
boolean

Active searches by default; false returns archived searches. An explicit value takes precedence over includeArchived.

includeArchived
boolean
default:false

Include active and archived searches. Omit active when using this option.

customFieldFilters
object[]

AND filters on configured customFields, applied before pagination. Use Rails bracket query encoding, for example customFieldFilters[][key]=process_by_agent&customFieldFilters[][operator]=is&customFieldFilters[][value]=true. Repeat the same filters with each cursor. Unknown/archived fields and invalid predicates return 422.

Maximum array length: 50

Response

Award saved searches

data
object[]
required
meta
object
required