Skip to main content
POST
/
api
/
external
/
v1
/
allocations
Allocation List
curl --request POST \
  --url https://app.magna.so/api/external/v1/allocations \
  --header 'Content-Type: application/json' \
  --header 'x-magna-api-token: <api-key>' \
  --data '
{
  "tokenId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cursor": "<string>",
  "limit": 99,
  "walletAddress": "<string>",
  "includeCurrentScheduleAmounts": true
}
'
{
  "isProcessed": true,
  "result": {
    "items": [
      {
        "id": "7eb179c5-d86a-4c0c-be29-198ad0cb39b0",
        "key": "A-SMJ7LTO1GS",
        "description": null,
        "amount": "12000",
        "funded": "0",
        "received": "0",
        "walletAddress": "B4uSUKyxdEgCJv6CUrynBAe8NjebnX6A1f6bprQFgZ7f",
        "createdAt": "2024-04-15T21:26:21.000Z",
        "updatedAt": "2024-04-15T21:26:21.000Z",
        "cancelledAt": null,
        "state": "NOT_STARTED",
        "stakeholder": {
          "id": "fe2d5104-36d5-4c79-b457-6bfcb1ae498c",
          "type": null,
          "employeeNumber": null,
          "name": null,
          "contactEmail": null,
          "xHandle": null
        },
        "customAttributes": [],
        "category": {
          "id": "3451cadc-dd25-4aee-b000-453756796a06",
          "name": "Category-Name"
        },
        "unlockStartAt": "2024-04-15T21:26:21.000Z",
        "vestingStartAt": "2024-04-15T21:26:21.000Z"
      }
    ],
    "cursor": "7eb179c5-d86a-4c0c-be29-198ad0cb39b0",
    "total": 1
  }
}

Authorizations

x-magna-api-token
string
header
required

Body

application/json
tokenId
string<uuid>
required
Minimum string length: 1
cursor
string
Minimum string length: 1
limit
number
Required range: x <= 100
walletAddress
string
Minimum string length: 1
includeCurrentScheduleAmounts
boolean

Response

Successful response

isProcessed
boolean
result
any

Endpoint-specific result payload.