Skip to main content
POST
/
api
/
external
/
v1
/
allocations
/
{id}
/
schedule
Schedule
curl --request POST \
  --url https://app.magna.so/api/external/v1/allocations/{id}/schedule \
  --header 'Content-Type: application/json' \
  --header 'x-magna-api-token: <api-key>' \
  --data '
{
  "types": [],
  "cursor": "<string>",
  "limit": 99
}
'
{
  "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
  }
}

Authorizations

x-magna-api-token
string
header
required

Path Parameters

id
string<uuid>
required
Minimum string length: 1

Body

application/json
types
enum<string>[]
Available options:
unlocked,
vested,
releasable
cursor
string
Minimum string length: 1
limit
number
Required range: x <= 100

Response

Successful response

isProcessed
boolean
result
any

Endpoint-specific result payload.