Skip to main content
GET
Get Allocation

Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

Required Permissions

Allocations:Read: Always required.

Authorizations

Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Path Parameters

allocationId
string
required

Unique identifier for the allocation investment.

Required string length: 1 - 64

Response

200 - application/json

Success

A allocation investment representing funds deposited to earn interest from a DeFi protocol.

id
string
required

Unique identifier for the allocation investment.

Required string length: 1 - 64
Pattern: ^allctn-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"allctn-7mnn0-rltpq-9bvps60gjm09td0j"

walletId
string
required

Wallet id.

Required string length: 1 - 64
Pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"wa-5pfuu-9euek-h0odgb6snva8ph3k"

protocol
enum<string>
required

The DeFi protocol used for allocation generation.

Available options:
0fns,
SkySusds,
GauntletUsdcPrime,
SteakhouseUsdt,
GauntletUsdcPrimeBase,
SteakhouseUsdcBase,
SentoraPyusdMain
amount
Native Asset · object
required

The total amount currently invested in this allocation.

rewards
Native Asset · object
required

The total rewards earned so far in this allocation.

dateCreated
string<date-time>
required

ISO 8601 date (must be UTC). ISO 8601 date. When the allocation was created.

Example:

"2023-04-14T20:41:28.715Z"

actions
object[]
required
provider
enum<string>

The provider handling this allocation.

Available options:
M0,
Yield.xyz
Last modified on July 9, 2026