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

# Holds

> Which authority is outstanding, behind the count on /v1/controls.

**Who may call it:** any role. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/controls/holds
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/controls/holds:
    get:
      tags:
        - Overview
      summary: Holds
      description: >-
        Which authority is outstanding, behind the count on /v1/controls.


        **Who may call it:** any role. A workspace API key is refused here: this
        is an act that belongs to a named person.
      operationId: holds_v1_controls_holds_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/HoldOut'
                type: array
                title: Response Holds V1 Controls Holds Get
      security:
        - bearerToken: []
components:
  schemas:
    HoldOut:
      properties:
        ledger_id:
          type: string
          title: Ledger Id
        grant_id:
          type: string
          title: Grant Id
        agent:
          type: string
          title: Agent
        environment:
          type: string
          title: Environment
        state:
          type: string
          title: State
        amount_minor:
          anyOf:
            - type: integer
            - type: 'null'
          title: Amount Minor
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        audience:
          anyOf:
            - type: string
            - type: 'null'
          title: Audience
        created_at:
          type: string
          format: date-time
          title: Created At
        age_minutes:
          type: integer
          title: Age Minutes
      type: object
      required:
        - ledger_id
        - grant_id
        - agent
        - environment
        - state
        - created_at
        - age_minutes
      title: HoldOut
      description: Authority handed out and not yet resolved.
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

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