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

# Schedule

> Retrieve an allocation's paginated unlock, vesting, and releasable schedule amounts.



## OpenAPI

````yaml /apis/admin/openapi.json post /api/external/v1/allocations/{id}/schedule
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/allocations/{id}/schedule:
    post:
      tags:
        - Allocations
      summary: Schedule
      description: >-
        Retrieve an allocation's paginated unlock, vesting, and releasable
        schedule amounts.
      operationId: postAllocationsByIdSchedule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type:
              - string
            minLength: 1
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type:
                - object
              properties:
                types:
                  type:
                    - array
                  items:
                    type:
                      - string
                    enum:
                      - unlocked
                      - vested
                      - releasable
                cursor:
                  type:
                    - string
                  minLength: 1
                limit:
                  type:
                    - number
                  exclusiveMinimum: 0
                  maximum: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  isProcessed:
                    type: boolean
                  result:
                    description: Endpoint-specific result payload.
              example:
                isProcessed: true
                result:
                  items:
                    - timestamp: '2024-01-01T00:00:00.000Z'
                      releasable: 4500
                      unlocked: 4500
                    - timestamp: '2024-01-02T00:00:00.000Z'
                      releasable: 200
                    - timestamp: '2024-01-03T00:00:00.000Z'
                      vested: 500
                  cursor: '2024-10-11T20:14:52.000Z'
                  total: 18
        '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

````