Endpoints to create large named or anonymous queries using the EPCIS Query Language. Named queries have a customname and are stored until deleted by the user. Anonymous queries are not persisted and only available to the caller.EPCIS events queries also support query subscription.
GS1 Queries API is one of 7 APIs that GS1 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Query. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.
This API exposes
10 operations
across 6 paths,
and defines 93 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.1.
Requests are made against the base URL https://id.gs1.org.
10 operations6 paths93 schemas3 DELETE5 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
2.0.1
Base URL
https://id.gs1.org
License
Apache2
Resource Areas
1
Paths & Operations 10
Across 6 paths, the API surfaces 10 operations — 3 DELETE, 5 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Queries 10
Endpoints to create large named or anonymous queries using the EPCIS Query Language. Named queries have a custom name and are stored until deleted by the user. Anonymous queries a…
GET
/queries
Returns a list of queries available.
7 params→ 200401403406500
POST
/queries
Creates a named EPCIS events query.
3 paramsbody→ 201401403406409415500
GET
/queries/{queryName}
Returns the query definition.
6 params→ 200401403404406413500
DELETE
/queries/{queryName}
Removes a named query and forcibly unsubscribes all active subscriptions, whether by WebSockets or Webhooks
1 param→ 204401403404406500
GET
/queries/{queryName}/subscriptions
Returns active subscriptions with the option to use pagination if needed.
Unsubscribes a client by deleting the query subscription.
unsubscribe2 params→ 204401403404406500
GET
/queries/{queryName}/events
Returns EPCIS events with the option to use pagination if needed. This endpoint supports query subscriptions using WebSockets.
21 params→ 101200400401403404406413
DELETE
/nextPageToken/{token}
Optional endpoint that allows on-demand release of any resources associated with nextPageToken.
1 param→ 204501
Schemas 93
The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are sensorReport (24 properties), sensorMetadata (8 properties), AbstractQuerySubscriptionResponse (7 properties), Event (7 properties). Each schema is shown below with its type and property counts.
queryResults
object
3 properties2 required
error-reason
ObjectEvent
ilmd
object
attribute
object
2 properties1 required
component
GS1-Extensions
object
Upgrade
string
The Upgrade and Connection headers are needed to open a Websocket for queries.
bizStep
sensorElement
object
2 properties1 required
eventID
QueryStreamSubscription
object
If no query schedule is specified, the client must explicitly set stream to true. This restriction is to prevent clients from accidentally subscribing to EPCIS…
1 property1 required
GS1-Next-Page-Token-Expires
string
GS1-EPCIS-Max
GS1-Signature
string
Used to sign events sent by the repository to subscribers. The choice of signature type is implementation specific but examples would be using HMAC with SHA-25…
AbstractQuerySubscriptionResponse
object
This schema contains shared features of EPCIS query subscriptions response.
7 properties3 required
errorDeclaration
object
3 properties1 required
certificationInfo
bizTransaction-type
resultsBody
object
2 properties1 required
disposition
QueryName
string
Unique query name.
GS1-EPC-Format
string
GS1-Query-DayOfMonth
string
Specifies that the query time must have a matching day of month value. The range for this parameter is 1 through 31, inclusive.
sensorReport
object
24 properties1 required
AggregationEvent
vocab-other-uri
string
AssociationEvent
GS1-Query-InitialRecordTime
string
Used to specify a time to constrain what resources are considered when processing a query subscription. This value only applies the first time a subscriber rec…
NextPageToken
string
Parameter that points to the next list of results when requesting a list of events that is larger than the value specified with the perPage parameter. Some tec…
vocab-uri
string
time
string
readPoint
object
1 property1 required
GS1-Query-DayOfWeek
string
Specifies that the query time must have a matching day of week value. The range for this parameter is 1 through 7, inclusive, with 1 denoting Monday, 2 denotin…
GS1-Query-Hour
string
Specifies that the query time must have a matching hour value. The range for this parameter is 0 through 23, inclusive, with 0 denoting the hour that begins at…
EPCISXMLQueryDocument
object
A collection of EPCIS resources.
GS1-Query-Min-Record-Time
string
In the context of an active query subscription, its value is set initially to initialRecordTime and then updated to the most recent execution timestamp for the…
id
string
uom
string
GS1-Query-Second
string
Specifies that the query time must have a matching seconds value. The range for this parameter is 0 through 59, inclusive.
source-dest-type
hexBinary
string
AbstractQuerySubscription
object
This schema contains shared features of EPCIS query subscriptions. If the schema is used in a response, the secret should not be fully revealed.
3 properties2 required
sensorAlertType
EPCISEvent
EPCIS Event. It must validate against the normative EPCIS JSON Schema or EPCIS SHACL .
decimal
number
TransactionEvent
GS1-EPCIS-Version
quantityList
array
vocabularyList
array
destination
object
2 properties2 required
sensorReportList
array
bizLocation
object
1 property1 required
Connection
string
The Upgrade and Connection headers are needed to open a Websocket for queries.
eventList
array
quantityElement
object
3 properties1 required
bizTransaction
object
2 properties1 required
epcisQueryDocumentBody
object
1 property1 required
version
string
dest
string
Callback URL to receive EPCIS resources and errors.
RFC7807ProblemResponseBody
object
A response as specified in [RFC 7807](https://tools.ietf.org/html/rfc7807).
5 properties2 required
source
object
2 properties2 required
boolean
boolean
uri
string
GS1-CBV-Min
GS1-Query-Stream
boolean
If no schedule is specified and stream is true, the standing subscription SHALL report immediately whenever a captured EPCIS event matches the query criteria.
QueryScheduleSubscription
object
A scheduled query subscription is a time-based query execution scheduler. EPCIS 2.0 scheduled queries are scheduled in the same manner as cron jobs. For exampl…
2 properties1 required
GS1-CBV-Max
persistentDisposition
LDContext
JSON-LD @context.
vocabularyElement
object
3 properties1 required
measurementType
EPCISEventsQuery
object
An EPCIS event query.
epcisQueryDocument
object
6 properties3 required
Extended-Event
GS1-CBV-XML-Format
string
sensorMetadata
object
8 properties
GS1-EPCIS-Min
QueryDefinition
object
Creating a new query with query body.
2 properties2 required
PerPage
integer
This parameter helps to control the amount of data returned to the client through pagination. In the case of EPCIS events, perPage specifies the maximum number…
vocabulary
object
2 properties1 required
vocab-nonGS1WebVoc-uri
string
GS1-Query-Minute
string
Specifies that the query time must have a matching minute value. The range for this parameter is 0 through 59, inclusive.
Event
object
7 properties2 required
epcList
array
action
string
GS1-Query-Month
string
Specifies that the query time must have a matching month value. The range for this parameter is 1 through 12, inclusive.
subscriptionID
string
The ID of a WebHook subscription.
string
string
GS1-CBV-Version
Link
string
A pagination header link. This header works together with the perPage and nextPageToken query string parameters.
TransformationEvent
GS1-Query-ReportIfEmpty
boolean
Flag to specify subscribed clients should be notified if the query result is empty.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of GS1 Queries API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
