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

# Remove a permission from an API key

> Take a granted permission away from an API key. Takes effect on the key's next request. Any Owner or Manager who can manage keys may remove one; removing a permission the key does not hold is not an error. Requires MANAGE_API_KEYS permission.



## OpenAPI

````yaml /openapi/openapi-account.json delete /account/api/v1/organizations/{organization_id}/api-keys/{key_id}/grants/{grant}
openapi: 3.1.0
info:
  title: Account API
  version: 1.0.0
  description: >
    Authenticate and manage users, organizations, and API keys.


    ## 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: Account
    description: Authenticate and introspect the current user and API key.
  - name: Organizations
    description: Create and manage organizations (businesses).
  - name: Members
    description: Invite, update, and remove organization members.
  - name: API Keys
    description: Create, list, and revoke API keys.
  - name: Preferences
    description: >-
      Create, list, update, and delete the authenticated user's stored trait
      preferences (allergens, dietary stances, certifications, sensitivities).
  - name: Scan History
    description: >-
      Read the current visitor's scan history (authenticated or
      anonymous/session-based) and capture anonymous resolver scans.
  - name: Enrollment Codes
    description: >-
      Mint, list, view, and revoke single-use manual enrollment codes for
      linking a retailer to your account.
  - name: Support
    description: >-
      Open, list, read and reply to your own support tickets, and send feature
      requests to the product team.
  - name: Feedback
    description: Submit product feedback.
  - name: Retailer Clients
    description: >-
      Register, list, rotate the secret of, and enable or disable the retailer
      API clients of an organization.
  - name: Retailer Enrollment
    description: >-
      Retailer-facing redemption of consumer enrollment codes, authenticated
      with a retailer client's credentials.
  - name: Retailer Links
    description: >-
      List, view, unlink, and delete purchase history for the retailers linked
      to your account.
  - name: Profile
    description: Read and update your own profile.
  - name: Invites
    description: Accept an invitation to join an organization.
  - name: Connected Apps
    description: List and disconnect the applications you have authorized.
  - name: Saved Items and Watching
    description: Save scanned products, clear viewed history, and manage product watches.
  - name: Consent Preferences
    description: Opt in or out of optional communications such as the newsletter.
  - name: Alerts
    description: >-
      Manage recall alert subscriptions and how alerts are delivered, including
      SMS verification.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /account/api/v1/organizations/{organization_id}/api-keys/{key_id}/grants/{grant}:
    delete:
      tags:
        - API Keys
      summary: Remove a permission from an API key
      description: >-
        Take a granted permission away from an API key. Takes effect on the
        key's next request. Any Owner or Manager who can manage keys may remove
        one; removing a permission the key does not hold is not an error.
        Requires MANAGE_API_KEYS permission.
      operationId: remove_api_key_grant
      parameters:
        - in: path
          name: organization_id
          schema:
            description: Organization ID.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: Organization ID.
        - in: path
          name: key_id
          schema:
            description: UUID of the API key.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Key Id
            type: string
          required: true
          description: UUID of the API key.
        - in: path
          name: grant
          schema:
            description: >-
              Permissions an Owner can grant one API key beyond its role.
              Mirrors ``accounts.models.APIKeyGrantType``.
            enum:
              - delete_traceability_records
            title: APIKeyGrantEnum
            type: string
          required: true
          description: >-
            Permissions an Owner can grant one API key beyond its role. Mirrors
            ``accounts.models.APIKeyGrantType``.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIKeyOut'
        '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:
    APIKeyOut:
      examples:
        - created: '2025-06-15T10:30:00Z'
          description: Main key for production environment
          grants: []
          id: d5e6f7a8-9012-3456-abcd-ef7890123456
          is_active: true
          last_used: '2025-06-20T08:00:00Z'
          metadata:
            order_id: '6735'
          name: Production API Key
          role: editor
      properties:
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: >-
            Developer-attached key/value data attached to this object. Up to 50
            keys; key max 40 chars, value max 500 chars.
          maxProperties: 50
          propertyNames:
            maxLength: 40
          title: Metadata
          type: object
        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
        name:
          description: Key name.
          title: Name
          type: string
        description:
          default: ''
          description: Key description.
          title: Description
          type: string
        role:
          $ref: '#/components/schemas/APIKeyRoleEnum'
          description: Permission role for this key within the organization.
        created:
          description: ISO 8601 creation timestamp.
          title: Created
          type: string
        is_active:
          description: False once the key has been revoked; a revoked key is refused.
          title: Is Active
          type: boolean
        last_used:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 timestamp of the key's last use, if it has been used.
          title: Last Used
        expires_at:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 expiry timestamp, if the key expires.
          title: Expires At
        grants:
          description: >-
            Permissions an Owner granted this key beyond its role. Empty for
            almost every key: no role carries these, and a key gains one only
            when an Owner grants it.
          items:
            $ref: '#/components/schemas/APIKeyGrantOut'
          title: Grants
          type: array
      required:
        - id
        - name
        - role
        - created
        - is_active
      title: APIKeyOut
      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
    APIKeyRoleEnum:
      description: API key permission roles. Mirrors ``accounts.models.APIKeyRole``.
      enum:
        - manager
        - editor
        - readonly
      title: APIKeyRoleEnum
      type: string
    APIKeyGrantOut:
      examples:
        - created: '2026-11-13T15:49:00+00:00'
          grant: delete_traceability_records
          in_effect: true
      properties:
        grant:
          $ref: '#/components/schemas/APIKeyGrantEnum'
          description: The permission granted beyond the key's role.
        created:
          description: ISO 8601 timestamp of when it was granted.
          title: Created
          type: string
        in_effect:
          description: >-
            False once the key is revoked, its role is no longer Manager, or the
            Owner who granted it is no longer an Owner of the organization; the
            key then cannot use it until a current Owner grants it again.
          title: In Effect
          type: boolean
      required:
        - grant
        - created
        - in_effect
      title: APIKeyGrantOut
      type: object
    APIKeyGrantEnum:
      description: >-
        Permissions an Owner can grant one API key beyond its role. Mirrors
        ``accounts.models.APIKeyGrantType``.
      enum:
        - delete_traceability_records
      title: APIKeyGrantEnum
      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.