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

> The recall activity dashboard for the products your organization owns: recalls in the last 90 days by regulator and by risk class, GTINs newly affected per day, how fast you approved matches, and consumer scans of recalled products over the last 30 days. Always scoped to the organization, whoever calls. Figures are cached for five minutes. Any role on the organization may read it; anyone else gets 404.



## OpenAPI

````yaml /openapi/openapi-compliance.json get /compliance/api/v1/organizations/{organization_id}/recall-activity
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}/recall-activity:
    get:
      tags:
        - Recall review
      summary: Get recall activity
      description: >-
        The recall activity dashboard for the products your organization owns:
        recalls in the last 90 days by regulator and by risk class, GTINs newly
        affected per day, how fast you approved matches, and consumer scans of
        recalled products over the last 30 days. Always scoped to the
        organization, whoever calls. Figures are cached for five minutes. Any
        role on the organization may read it; anyone else gets 404.
      operationId: get_recall_activity
      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.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecallActivityOut'
        '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:
    RecallActivityOut:
      description: Recall activity affecting the products your organization owns.
      examples:
        - affected_gtins_over_time:
            - count: 3
              date: '2026-11-01'
          recalls_by_severity:
            - count: 7
              key: CLASS_II
              label: Class II
          recalls_by_source:
            - count: 12
              key: FDA
              label: FDA
          scan_volume_for_recalled_items:
            - date: '2026-11-01'
              scans: 41
          time_to_acknowledge:
            count: 4
            mean_hours: 27.3
            p50_hours: 18.5
            p90_hours: 52
          window_days: 90
      properties:
        window_days:
          description: Length of the recall window the counts cover, in days.
          title: Window Days
          type: integer
        recalls_by_source:
          description: Recalls in the window, by issuing regulator.
          items:
            $ref: '#/components/schemas/RecallCountRowOut'
          title: Recalls By Source
          type: array
        recalls_by_severity:
          description: Recalls in the window, by risk class.
          items:
            $ref: '#/components/schemas/RecallCountRowOut'
          title: Recalls By Severity
          type: array
        affected_gtins_over_time:
          description: 'One row per day of the window: GTINs newly affected.'
          items:
            $ref: '#/components/schemas/RecallDailyGtinsOut'
          title: Affected Gtins Over Time
          type: array
        time_to_acknowledge:
          anyOf:
            - $ref: '#/components/schemas/RecallTimeToAcknowledgeOut'
            - type: 'null'
          description: Null when no match has been approved in the window.
        scan_volume_for_recalled_items:
          description: 'One row per day of the last 30: consumer scans of recalled products.'
          items:
            $ref: '#/components/schemas/RecallDailyScansOut'
          title: Scan Volume For Recalled Items
          type: array
      required:
        - window_days
        - recalls_by_source
        - recalls_by_severity
        - affected_gtins_over_time
        - scan_volume_for_recalled_items
      title: RecallActivityOut
      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
    RecallCountRowOut:
      description: One bucket of a recall count.
      examples:
        - count: 12
          key: FDA
          label: FDA
      properties:
        key:
          description: >-
            Machine value of the bucket, for example a source system or
            severity.
          title: Key
          type: string
        label:
          description: Human-readable name of the bucket.
          title: Label
          type: string
        count:
          description: Number of recalls in the bucket.
          title: Count
          type: integer
      required:
        - key
        - label
        - count
      title: RecallCountRowOut
      type: object
    RecallDailyGtinsOut:
      description: Distinct GTINs newly affected by recalls on one day.
      examples:
        - count: 3
          date: '2026-11-01'
      properties:
        date:
          description: Calendar day.
          format: date
          title: Date
          type: string
        count:
          description: GTINs affected that day.
          title: Count
          type: integer
      required:
        - date
        - count
      title: RecallDailyGtinsOut
      type: object
    RecallTimeToAcknowledgeOut:
      description: >-
        How long your organization took to approve recall matches, from the
        recall's publication.
      examples:
        - count: 4
          mean_hours: 27.3
          p50_hours: 18.5
          p90_hours: 52
      properties:
        count:
          description: Recalls with an approved match in the window.
          title: Count
          type: integer
        p50_hours:
          description: Median hours from the recall date to the first approval.
          title: P50 Hours
          type: number
        p90_hours:
          description: 90th percentile of the same.
          title: P90 Hours
          type: number
        mean_hours:
          description: Mean of the same.
          title: Mean Hours
          type: number
      required:
        - count
        - p50_hours
        - p90_hours
        - mean_hours
      title: RecallTimeToAcknowledgeOut
      type: object
    RecallDailyScansOut:
      description: Consumer scans of recalled products on one day.
      examples:
        - date: '2026-11-01'
          scans: 41
      properties:
        date:
          description: Calendar day.
          format: date
          title: Date
          type: string
        scans:
          description: Scans of products attached to a recall that day.
          title: Scans
          type: integer
      required:
        - date
        - scans
      title: RecallDailyScansOut
      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.