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

# Locked Supply

> Retrieve the locked supply of a token — allocated tokens under an active schedule that have not yet released.

**Required scope:** one of `EXTERNAL_STATS_READ` (or a Full Access token).



## OpenAPI

````yaml /apis/admin/openapi.json get /api/external/v1/tokens/{id}/locked-supply
openapi: 3.1.0
info:
  title: Magna Admin API
  version: 1.0.0
  description: >-
    The private, server-to-server API for managing allocations, funding and
    claims, transactions, portals, and token data. Authenticated with a project
    API key sent in the `x-magna-api-token` header.
servers:
  - url: https://app.magna.so
    description: Production
security:
  - apiToken: []
paths:
  /api/external/v1/tokens/{id}/locked-supply:
    get:
      tags:
        - Statistics
      summary: Locked Supply
      description: >-
        Retrieve the locked supply of a token — allocated tokens under an active
        schedule that have not yet released.


        **Required scope:** one of `EXTERNAL_STATS_READ` (or a Full Access
        token).
      operationId: getTokensByIdLockedSupply
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type:
              - string
            minLength: 1
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            text/plain:
              schema:
                type: string
              example: '550000000'
        '400':
          description: Validation error
        '401':
          description: Missing or invalid API token
        '403':
          description: API token lacks the required scope or project access
components:
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: x-magna-api-token

````