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

# Allocation by ID

> Retrieve a single allocation by ID, including its calculated status and claimable amount.



## OpenAPI

````yaml /apis/admin/openapi.json get /api/external/v1/allocations/{id}
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}:
    get:
      tags:
        - Allocations
      summary: Allocation by ID
      description: >-
        Retrieve a single allocation by ID, including its calculated status and
        claimable amount.
      operationId: getAllocationsById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type:
              - string
            minLength: 1
            format: uuid
        - name: includeCurrentScheduleAmounts
          in: query
          required: false
          schema:
            type:
              - boolean
      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:
                  id: 7eb179c5-d86a-4c0c-be29-198ad0cb39b0
                  key: A-SMJ7LTO1GS
                  description: null
                  amount: '12000'
                  funded: '0'
                  received: '0'
                  createdAt: '2024-04-15T21:26:21.000Z'
                  updatedAt: '2024-04-15T21:26:21.000Z'
                  cancelledAt: null
                  walletAddress: B4uSUKyxdEgCJv6CUrynBAe8NjebnX6A1f6bprQFgZ7f
                  stakeholder:
                    id: fe2d5104-36d5-4c79-b457-6bfcb1ae498c
                    type: null
                    employeeNumber: null
                    name: null
                    contactEmail: null
                    xHandle: null
                  customAttributes: []
                  status: NOT_STARTED
                  claimable: '0'
                  category:
                    id: 3451cadc-dd25-4aee-b000-453756796a06
                    name: Test
                  unlockStartAt: '2024-04-15T21:26:21.000Z'
                  vestingStartAt: '2024-04-15T21:26:21.000Z'
        '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

````