Skip to main content
POST
Search Profiles

Authorizations

x-api-key
string
header
required

Your Prism API key. You can get one for free in the Prism Dashboard.

Body

application/json
filter
object

Conditions that a profile must satisfy to be included in the results. Each key is either a field path paired with comparison operators, or a logical operator ($and, $or) that combines nested filter objects.

Example:
sort
object

Rule that determines the order in which matching profiles are returned.

dynamic_labels
object

Map of custom label names to filter rules. Each returned profile is tagged with a label when its data satisfies the corresponding filter, allowing you to annotate results with ad-hoc categories defined at query time.

Example:
options
object

Controls which optional sections are included in each returned position profile.

limit
integer
default:20

Maximum number of results to return in a single page.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor returned by a previous response. Pass it to fetch the next page of results.

Response

List of position profiles found from the search.

count
integer

Total number of matching items

cursor
string

Cursor for pagination

data
object[]