Skip to content
Steward Developers
Back to Steward

Global search across applications, screening, documents, and tasks

GET
/api/v1/platform/search

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
q
string
Example
sarah

Search query (min 2 chars)

type
string
Allowed values: all applications screening documents tasks
limit
number
>= 1 <= 50

Per-category result limit

offset
number

Per-category offset for pagination (single-tab mode only)

includeDismissed
boolean

Include DISMISSED screening hits in screening results

sortOrder
string
Allowed values: newest oldest
applicationStatus
Array<string>

Filter applications by status

screeningType
Array<string>

Filter screening hits by type

documentEntityType
string
Allowed values: individual business

Filter documents by owning entity type

taskState
string
Allowed values: RESOLVED INCOMPLETE

Filter tasks by resolution state

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Grouped search results scoped to the caller account

object
applications
required
object
items
required
Array<object>
object
id
required
string
name
required

Display name (submitter or business name)

string
entityType
string
Allowed values: individual business
status
required
string
createdAt
required
string format: date-time
total
required

Total matches in this section, ignoring pagination

number
screening
required
object
items
required
Array<object>
object
id
required
string
title
required

Matched name on the screening hit

string
type
required
string
status
required
string
applicationId
required
string
applicationName
string
keyPersonId

Individual or business id this hit belongs to (used as keyPersonId in the screening route)

string
total
required
number
documents
required
object
items
required
Array<object>
object
id
required
string
fileName
required
string
type
required
string
subType
string
applicationId
string
applicationName
string
total
required
number
tasks
required
object
items
required
Array<object>
object
id
required
string
title
required
string
type
required
string
status
required
string
applicationId
required
string
applicationName
string
total
required
number
Example
{
  "applications": {
    "items": [],
    "total": 0
  },
  "screening": {
    "items": [],
    "total": 0
  },
  "documents": {
    "items": [],
    "total": 0
  },
  "tasks": {
    "items": [],
    "total": 0
  }
}