> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List named queries

> Your organization's named queries, each as ``{name, query}``, in name order (GS1 EPCIS 2.0 REST binding, ``GET /queries``). Paginated: while more remain, ``Link`` (``rel="next"``) names the next page and ``GS1-Next-Page-Token-Expires`` says how long its token is guaranteed valid. Caller must hold OWNER or MANAGER on an organization.



## OpenAPI

````yaml /openapi/openapi-epcis.json get /epcis/api/2.0/queries
openapi: 3.1.0
info:
  title: EPCIS 2.0 API
  version: 2.0.0
  description: >
    EPCIS 2.0 event capture and query, scoped to lot-level supply chain
    traceability and recall containment — not warehouse logistics, cold-chain
    monitoring, or business-document exchange.


    Roles claimed: EPCIS 2.0 capture interface server, EPCIS 2.0 data. Not
    claimed: EPCIS 2.0 query interface server; Query callback interface
    implementation.


    Binding: REST over HTTPS. Serialization: JSON and JSON-LD. Vocabulary: GS1
    CBV 2.0. XML and EPCIS 1.2 are out of scope by design, not a pending
    decision.


    30 of 63 official EPCIS 2.0 REST operations are served, all within the roles
    claimed above. Full capability declaration:
    https://docs.closient.com/guides/epcis-conformance


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /epcis/api/2.0/queries:
    get:
      tags:
        - EPCIS 2.0
      summary: List named queries
      description: >-
        Your organization's named queries, each as ``{name, query}``, in name
        order (GS1 EPCIS 2.0 REST binding, ``GET /queries``). Paginated: while
        more remain, ``Link`` (``rel="next"``) names the next page and
        ``GS1-Next-Page-Token-Expires`` says how long its token is guaranteed
        valid. Caller must hold OWNER or MANAGER on an organization.
      operationId: epcis_list_named_queries
      parameters:
        - in: query
          name: perPage
          schema:
            default: 30
            description: >-
              Maximum number of queries to return per page (1-100, default 30).
              When more remain, the response carries a ``Link`` header with
              ``rel="next"``.
            maximum: 100
            minimum: 1
            title: Perpage
            type: integer
          required: false
          description: >-
            Maximum number of queries to return per page (1-100, default 30).
            When more remain, the response carries a ``Link`` header with
            ``rel="next"``.
        - in: query
          name: nextPageToken
          schema:
            description: >-
              Cursor for the next page. The ``Link`` header's next-page URL
              already carries it; opaque to the client — do not construct or
              modify.
            title: Nextpagetoken
            type: string
            pattern: ^[^\x00]{0,}$
          required: false
          description: >-
            Cursor for the next page. The ``Link`` header's next-page URL
            already carries it; opaque to the client — do not construct or
            modify.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NamedQueryDefinitionSchema'
                title: Response
                type: array
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
            Link:
              schema:
                type: string
              description: >-
                URL of the next page with ``rel="next"`` (RFC 8288), carrying
                the original query plus ``nextPageToken``. Absent on the last
                page: no ``rel="next"`` means there is nothing more.
            GS1-Next-Page-Token-Expires:
              schema:
                format: date-time
                type: string
              description: >-
                Time until which the ``nextPageToken`` in ``Link`` is guaranteed
                valid. Present only alongside ``Link``. Closient cursors are
                stateless and are also honoured after it.
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '406':
          description: Error
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '500':
          description: Error
          headers:
            GS1-EPCIS-Version:
              schema:
                type: string
              description: EPCIS version of the payload being returned.
            GS1-EPCIS-Min:
              schema:
                type: string
              description: Oldest EPCIS version this server accepts or serves.
            GS1-EPCIS-Max:
              schema:
                type: string
              description: Newest EPCIS version this server accepts or serves.
            GS1-CBV-Version:
              schema:
                type: string
              description: CBV version in effect.
            GS1-CBV-XML-Format:
              schema:
                type: string
              description: >-
                CBV URI style preference for XML responses; this server is JSON
                only.
            GS1-EPC-Format:
              schema:
                type: string
              description: >-
                Whether EPCs are always URNs, always Digital Link URIs, or
                neither.
            GS1-Extensions:
              schema:
                type: string
              description: Vendor extensions active on this response; empty when none.
            GS1-Vendor-Version:
              schema:
                type: string
              description: Build identity of this server.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    NamedQueryDefinitionSchema:
      description: >-
        A named query: the standard's ``QueryDefinition`` (``POST /queries``
        body, ``GET /queries`` items).
      examples:
        - name: myQuery
          query:
            EQ_bizStep:
              - shipping
              - receiving
            eventType:
              - ObjectEvent
      properties:
        name:
          description: >-
            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 ``.``.
          maxLength: 255
          minLength: 1
          pattern: ^[A-Za-z0-9_~-][A-Za-z0-9._~-]{0,254}$
          title: Name
          type: string
        query:
          additionalProperties: false
          description: >-
            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.
          properties:
            '@context':
              anyOf:
                - pattern: ^[^\x00]{1,2048}$
                  type: string
                - items:
                    pattern: ^[^\x00]{1,2048}$
                    type: string
                  minItems: 1
                  type: array
            eventType:
              items:
                enum:
                  - AggregationEvent
                  - AssociationEvent
                  - ObjectEvent
                  - TransactionEvent
                  - TransformationEvent
                type: string
              minItems: 1
              type: array
            GE_eventTime:
              format: date-time
              type: string
            LT_eventTime:
              format: date-time
              type: string
            EQ_action:
              items:
                enum:
                  - ADD
                  - DELETE
                  - OBSERVE
                type: string
              minItems: 1
              type: array
            EQ_bizStep:
              items:
                pattern: ^[^\x00]{1,2048}$
                type: string
              minItems: 1
              type: array
            EQ_disposition:
              items:
                pattern: ^[^\x00]{1,2048}$
                type: string
              minItems: 1
              type: array
            EQ_readPoint:
              items:
                pattern: ^[^\x00]{1,2048}$
                type: string
              minItems: 1
              type: array
            EQ_bizLocation:
              items:
                pattern: ^[^\x00]{1,2048}$
                type: string
              minItems: 1
              type: array
            MATCH_epc:
              items:
                pattern: ^[^\x00]{1,2048}$
                type: string
              minItems: 1
              type: array
            MATCH_anyEPC:
              items:
                pattern: ^[^\x00]{1,2048}$
                type: string
              minItems: 1
              type: array
          title: Query
          type: object
      required:
        - name
        - query
      title: NamedQueryDefinitionSchema
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.