Skip to main content
GET
List named queries

Authorizations

X-API-Key
string
header
required

Query Parameters

perPage
integer
default:30

Maximum number of queries 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

name
string
required

Unique name of the query in your organization; its URL is /queries/{name}. 1-255 characters from A-Z, a-z, 0-9 and . _ ~ -, not starting with ..

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_~-][A-Za-z0-9._~-]{0,254}$
query
Query · object
required

An EPCIS 2.0 query object (https://ref.gs1.org/standards/epcis/2.0.0/query-schema.json). Supported parameters: eventType, GE_eventTime, LT_eventTime, EQ_action, EQ_bizStep, EQ_disposition, EQ_readPoint, EQ_bizLocation, MATCH_epc and MATCH_anyEPC; a query naming any other parameter is refused with 400 rather than run without it. Every parameter except the two times is an array, matching any of its values.