> ## 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 routing rules

> Return the organization's conditional routing rules, active and inactive, ordered by product then evaluation order, in the standard ``{data, pagination}`` envelope. Pass ``gtin`` for one product's rules. Each rule's ``effective`` flag says whether it can change a scan. Requires VIEW permission.



## OpenAPI

````yaml /openapi/openapi-resolver.json get /resolver/api/v1/organizations/{organization_id}/routing-rules
openapi: 3.1.0
info:
  title: Resolver API
  version: 1.0.0
  description: >
    GS1 Digital Link resolution with content negotiation and linkset support.


    ## 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: []
tags:
  - name: Resolver
    description: GS1 Digital Link resolution with content negotiation and linkset support.
  - name: Custom URLs
    description: >-
      Reusable custom-URL catalog — create, list, edit, and delete the custom
      redirect destinations that resolution rules point at.
  - name: Resolver Configuration
    description: >-
      Organization resolver settings and per-product resolver state — the
      routing timezone, whether the resolver serves a product, and its per-GTIN
      behavior controls (enhanced resolution, expiry, serial policy, shelf-life
      offset, age gate). The same audited writes the dashboard pages make.
  - name: Link-type sections
    description: >-
      Organization-owned GS1 link-type records — documents (GDTI), coupons (GCN)
      and service relations (GSRN): list, read, create, update and delete. The
      same audited writes the dashboard's Link-type sections page makes.
  - name: Routing rules
    description: >-
      Conditional routing rules — per-product rules that decorate the redirect a
      scan resolves to (query parameters and/or the path) when the scanned date,
      lot or serial matches: list, read, create, update, activate and
      deactivate. Rules are never deleted. The same audited writes the
      dashboard's Routing rules pages make.
  - name: Verification
    description: >-
      Serial verification (`gs1:verificationService`) — tiered, rate-limited
      responses for serialized GTIN scans. Experimental v1; see the
      verification-service guide.
  - name: GS1 Primitives (Public)
    description: >-
      Keyless GS1 Digital Link primitives — parse, validate, build, decompress,
      and check-digit analysis. **No API key, no signup.** Pure functions over
      strings: no database, no network, no catalog data. IP-throttled and
      edge-cached so repeat calls cost nothing. This is the reference
      implementation the resolver itself runs on.
  - name: Resolver Custom Hostnames
    description: >-
      BYO domain — register a customer-owned hostname, publish the CNAME
      records, verify ownership, and serve an org's Digital Link QRs from its
      own DNS.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /resolver/api/v1/organizations/{organization_id}/routing-rules:
    get:
      tags:
        - Routing rules
      summary: List routing rules
      description: >-
        Return the organization's conditional routing rules, active and
        inactive, ordered by product then evaluation order, in the standard
        ``{data, pagination}`` envelope. Pass ``gtin`` for one product's rules.
        Each rule's ``effective`` flag says whether it can change a scan.
        Requires VIEW permission.
      operationId: list_routing_rules
      parameters:
        - in: path
          name: organization_id
          schema:
            description: UUID of the organization that owns the rules.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: UUID of the organization that owns the rules.
        - in: query
          name: gtin
          schema:
            description: Only the rules of this product (its GTIN).
            title: Gtin
            maxLength: 14
            type: string
            pattern: ^[^\x00]{0,14}$
          required: false
          description: Only the rules of this product (its GTIN).
        - in: query
          name: page
          schema:
            default: 1
            description: Page number (1-indexed).
            maximum: 10000000
            minimum: 1
            title: Page
            type: integer
          required: false
          description: Page number (1-indexed).
        - in: query
          name: page_size
          schema:
            default: 25
            description: Number of items per page (max 100).
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
          required: false
          description: Number of items per page (max 100).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedRoutingRuleOut'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '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'
        '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'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    PagedRoutingRuleOut:
      properties:
        data:
          description: >-
            Items on the current page, each conforming to the endpoint's item
            schema. Empty when the result set is empty or ``page`` is past the
            end.
          items:
            $ref: '#/components/schemas/RoutingRuleOut'
          title: Data
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
          description: Pagination envelope describing position within the full result set.
      required:
        - data
        - pagination
      title: PagedRoutingRuleOut
      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
    RoutingRuleOut:
      description: A routing rule as read from the API.
      examples:
        - created: '2026-06-01T09:00:00Z'
          effective: true
          gtin: '09506000134352'
          id: a1b2c3d4e5f6
          is_active: true
          match_values:
            - L2406A
            - L2406B
          modified: '2026-06-19T14:30:00Z'
          name: Recalled lots to landing page
          organization_id: b2c3d4e5-f678-9012-abcd-ef2345678901
          param_overrides:
            utm_campaign: recall-{lot}
          path_override: /lot-notice
          predicate_kind: LOT_LIST
          priority: 100
      properties:
        id:
          description: >-
            URL-safe 22-character shortuuid encoding of the row's UUID primary
            key. Stable across the row's lifetime; suitable for sharing in URLs,
            log lines, and external SDK clients. Accepted on input as either the
            shortuuid form or the canonical UUID form
            (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``).
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        gtin:
          description: The GTIN of the product this rule decorates.
          title: Gtin
          type: string
        name:
          description: Operator-facing label (max 100 characters).
          title: Name
          type: string
        priority:
          description: >-
            Lower priorities are evaluated first and the first matching rule
            wins (0 to 32767, default 100).
          title: Priority
          type: integer
        predicate_kind:
          $ref: '#/components/schemas/RoutingRulePredicateKindEnum'
          description: >-
            What the rule matches: DATE_WINDOW (the scanned use-by or
            best-before date falls in the window), LOT_LIST (the scanned lot, AI
            10, is in match_values) or SERIAL_SET (the scanned serial, AI 21, is
            in match_values).
        window_start:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: 'DATE_WINDOW: inclusive start (YYYY-MM-DD); null for no lower bound.'
          title: Window Start
        window_end:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: 'DATE_WINDOW: inclusive end (YYYY-MM-DD); null for no upper bound.'
          title: Window End
        match_values:
          description: >-
            LOT_LIST or SERIAL_SET: the lot or serial values to match, one entry
            each.
          items:
            type: string
          title: Match Values
          type: array
        param_overrides:
          additionalProperties:
            type: string
          description: >-
            Query parameters to set on the redirect when the rule matches: a
            flat map of string keys to string values. Values may use tokens such
            as {gtin} and {lot}.
          title: Param Overrides
          type: object
        path_override:
          description: >-
            A same-host absolute path to swap into the destination when the rule
            matches (for example /spring-sale); empty keeps the destination's
            path. Must start with a single '/'.
          title: Path Override
          type: string
        is_active:
          description: >-
            Whether the rule is switched on. A deactivated rule is never
            evaluated.
          title: Is Active
          type: boolean
        effective:
          description: >-
            Whether the rule can change a scan: true only when it is active and
            its product has the Enhanced ROUTING_RULES capability. A rule on a
            product without it is saved but inert; read this back after a write.
          title: Effective
          type: boolean
        organization_id:
          description: UUID of the organization that owns the product.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Organization Id
          type: string
        created:
          description: ISO-8601 creation timestamp.
          format: date-time
          title: Created
          type: string
        modified:
          description: ISO-8601 last-modified timestamp.
          format: date-time
          title: Modified
          type: string
      required:
        - id
        - gtin
        - name
        - priority
        - predicate_kind
        - match_values
        - param_overrides
        - path_override
        - is_active
        - effective
        - organization_id
        - created
        - modified
      title: RoutingRuleOut
      type: object
    PaginationMeta:
      description: >-
        Page envelope returned alongside ``data`` on every paginated list
        endpoint.
      examples:
        - has_next: true
          has_previous: false
          page: 1
          page_size: 25
          total_count: 342
          total_pages: 14
      properties:
        page:
          description: >-
            1-indexed page number that was returned. Echoes the ``?page=`` query
            parameter.
          examples:
            - 1
          minimum: 1
          title: Page
          type: integer
        page_size:
          description: >-
            Number of items returned in ``data`` for this page. Capped at the
            endpoint's maximum page size (typically 100).
          examples:
            - 25
          minimum: 1
          title: Page Size
          type: integer
        total_count:
          description: Total number of items matching the query across all pages.
          examples:
            - 342
          minimum: 0
          title: Total Count
          type: integer
        total_pages:
          description: >-
            Total number of pages at the current ``page_size``. Always at least
            1 (an empty result still reports ``total_pages: 1``).
          examples:
            - 14
          minimum: 1
          title: Total Pages
          type: integer
        has_next:
          description: >-
            True when ``page < total_pages`` — clients can request
            ``page=page+1`` to continue.
          examples:
            - true
          title: Has Next
          type: boolean
        has_previous:
          description: >-
            True when ``page > 1`` — clients can request ``page=page-1`` to go
            back.
          examples:
            - false
          title: Has Previous
          type: boolean
      required:
        - page
        - page_size
        - total_count
        - total_pages
        - has_next
        - has_previous
      title: PaginationMeta
      type: object
    RoutingRulePredicateKindEnum:
      description: Mirrors ``RoutingRule.PredicateKind``.
      enum:
        - DATE_WINDOW
        - LOT_LIST
        - SERIAL_SET
      title: RoutingRulePredicateKindEnum
      type: string
  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.