Skip to main content
POST
Run an ad-hoc OpalQuery

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for running an ad-hoc OpalQuery. The type field determines which query schema applies.

type
enum<string>
required
Available options:
NODE
query
object

The filter body for a NODE-type OpalQuery.

first
integer

Maximum number of results to return. Defaults to 200.

Example:

200

after
string

Cursor from a previous response to fetch the next page of results.

Example:

"29827fb8-f2dd-4e80-9576-28e31e9934ac"

Response

200 - application/json

The results of the OpalQuery.

Paginated results of an OpalQuery. The type field discriminates which result schema applies and mirrors the type field on the request.

type
enum<string>
required
Available options:
NODE
edges
object[]
required

List of matched entities.

pageInfo
object
required
Last modified on July 23, 2026