Skip to main content
GET
Run a named query

Authorizations

X-API-Key
string
header
required

Path Parameters

query_name
string
required

The name the query was created with (POST /queries).

Query Parameters

perPage
integer
default:30

Maximum number of events to return per page (1-100, default 30). When more remain, the response carries a Link header with rel="next".

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

Cursor for the next page. The Link header's next-page URL already carries it; opaque to the client — do not construct or modify.

Pattern: ^[^\x00]{0,}$

Response

OK

200 response body for GET /queries/{queryName}/events: a JSON-LD EPCISQueryDocument.

Shaped as the standard's epcisQueryDocument: queryResults.queryName names the query and queryResults.resultsBody.eventList holds the events.

@context
string[]
required

JSON-LD context; the EPCIS 2.0 context.

type
string
required

Always EPCISQueryDocument.

epcisBody
NamedQueryEPCISBodySchema · object
required

Envelope holding queryResults.

Example: