> ## 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.

# Get a where-used report

> Where a lot went (`direction=downstream`, the recall question) or what went into it (`direction=upstream`), with each reached lot's recall status. Any role on the organization may read it; a lot that does not exist, or belongs to another organization, is 404.



## OpenAPI

````yaml /openapi/openapi-compliance.json get /compliance/api/v1/organizations/{organization_id}/where-used/lots/{node_id}
openapi: 3.1.0
info:
  title: Compliance API
  version: 1.0.0
  description: >
    Product safety and compliance data: recalls, hazards, and remedies; and an
    organization's FSMA 204 settings and record-retention minimums.


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


    Those windows are per key. Your plan also caps each organization per hour,
    across every key,

    login and session acting for it: 100 requests on Free (or while a
    subscription is lapsed),

    10,000 on Business. While a subscription is lapsed, any method other than
    `GET`, `HEAD` and

    `OPTIONS` returns `403`.


    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).


    ## Versioning and Deprecation


    Every response from an operation in this document carries
    `Closient-API-Version` (its `info.version`).

    An operation marked `deprecated` answers with `Deprecation: @<Unix seconds>`

    ([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745)), `Sunset: <HTTP-date>`
    once a

    retirement date is set ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)),
    and

    `Link` entries for `rel="deprecation"`, `rel="sunset"` and
    `rel="successor-version"`.

    After its sunset it answers `410 Gone` naming the replacement. Policy:

    https://docs.closient.com/api-versioning
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Compliance
    description: Product recall and safety queries.
  - name: FSMA configuration
    description: >-
      An organization's FSMA 204 designated contact, lot-code settings and
      retention minimums.
  - name: FSMA 204 exemptions and harvest areas
    description: >-
      The § 1.1305 exemptions an organization declares and the harvest areas its
      farms record.
  - name: EPCIS capture configuration
    description: >-
      An organization's EPCIS capture keys, serial-number pools and public-page
      visibility.
  - name: FSMA recordkeeping
    description: >-
      An organization's FSMA 204 trading partners, reference documents,
      traceability plan versions and mock FDA audits.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /compliance/api/v1/organizations/{organization_id}/where-used/lots/{node_id}:
    get:
      tags:
        - FSMA traceability
      summary: Get a where-used report
      description: >-
        Where a lot went (`direction=downstream`, the recall question) or what
        went into it (`direction=upstream`), with each reached lot's recall
        status. Any role on the organization may read it; a lot that does not
        exist, or belongs to another organization, is 404.
      operationId: get_where_used_report
      parameters:
        - in: path
          name: organization_id
          schema:
            description: Identifier of the organization.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: Identifier of the organization.
        - in: path
          name: node_id
          schema:
            description: Identifier of the lot node, from the lot search.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Node Id
            type: string
          required: true
          description: Identifier of the lot node, from the lot search.
        - in: query
          name: direction
          schema:
            default: downstream
            description: Which way to walk.
            enum:
              - downstream
              - upstream
            title: Direction
            type: string
          required: false
          description: Which way to walk.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhereUsedReportOut'
        '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:
    WhereUsedReportOut:
      description: >-
        A genealogy report for one lot, forward (where used) or reverse (input
        genealogy).
      examples:
        - coverage: recorded
          direction: downstream
          max_depth: 10
          recalled_count: 0
          rows: []
          subject: LOT-4471
          truncated: false
      properties:
        direction:
          description: '`downstream` (where the lot went) or `upstream` (what went into it).'
          title: Direction
          type: string
        subject:
          description: The lot the report is about.
          title: Subject
          type: string
        coverage:
          description: >-
            What we hold about the lot: `recorded`, `no_links_recorded`
            (indexed, nothing linked) or `not_indexed`. It says what we hold,
            never what the world contains.
          title: Coverage
          type: string
        max_depth:
          description: The deepest step the walk takes.
          title: Max Depth
          type: integer
        truncated:
          description: Whether the walk stopped at `max_depth` with lots left to reach.
          title: Truncated
          type: boolean
        recalled_count:
          description: How many listed lots are under an active recall.
          title: Recalled Count
          type: integer
        rows:
          items:
            $ref: '#/components/schemas/WhereUsedRowOut'
          title: Rows
          type: array
      required:
        - direction
        - subject
        - coverage
        - max_depth
        - truncated
        - recalled_count
        - rows
      title: WhereUsedReportOut
      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
    WhereUsedRowOut:
      description: One lot the walk reached.
      examples:
        - depth: 1
          lot:
            gtin: ''
            id: cS6pH9bI5moTvZr1NeYaXJ
            kind: supplier_lot
            label: LOT-4471
            lot_identifier: LOT-4471
            product_reference: ''
            supplier_gln: ''
            supplier_name: Riverbend Produce (Demo)
          product_name: ''
          recall_status: none
          unit_of_measure: ''
      properties:
        depth:
          description: Steps from the subject lot; 1 is a direct link.
          title: Depth
          type: integer
        lot:
          $ref: '#/components/schemas/LotNodeOut'
        product_name:
          description: The product's name, when the lot is a registered one; else empty.
          title: Product Name
          type: string
        quantity:
          anyOf:
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
              type: string
            - type: 'null'
          description: The registered lot's quantity, when known.
          title: Quantity
        unit_of_measure:
          description: Unit of `quantity`.
          title: Unit Of Measure
          type: string
        recall_status:
          description: >-
            `active` (an active recall covers it), `none`, or `unknown` (cannot
            be determined).
          title: Recall Status
          type: string
      required:
        - depth
        - lot
        - product_name
        - unit_of_measure
        - recall_status
      title: WhereUsedRowOut
      type: object
    LotNodeOut:
      description: A lot in the organization's genealogy graph.
      examples:
        - gtin: ''
          id: cS6pH9bI5moTvZr1NeYaXJ
          kind: supplier_lot
          label: LOT-4471
          lot_identifier: LOT-4471
          product_reference: Roma tomatoes, 25 lb case
          supplier_gln: ''
          supplier_name: Riverbend Produce (Demo)
      properties:
        id:
          description: Identifier of the lot node; pass it to the where-used report.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        kind:
          description: >-
            How the lot is identified: a registered lot, a supplier lot or a
            window.
          title: Kind
          type: string
        label:
          description: A readable name for the lot.
          title: Label
          type: string
        gtin:
          description: The lot's GTIN; empty when it has none.
          title: Gtin
          type: string
        lot_identifier:
          description: The lot code; empty when it has none.
          title: Lot Identifier
          type: string
        supplier_name:
          description: The supplier's name as recorded; empty when none.
          title: Supplier Name
          type: string
        supplier_gln:
          description: The supplier's Global Location Number; empty when none.
          title: Supplier Gln
          type: string
        product_reference:
          description: The supplier's product reference as recorded.
          title: Product Reference
          type: string
      required:
        - id
        - kind
        - label
        - gtin
        - lot_identifier
        - supplier_name
        - supplier_gln
        - product_reference
      title: LotNodeOut
      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.