Get allocation details by uid

🚧
Important:
Request headers are required. See API basics introduction for more information.

Get allocation details by uid

Endpoint

GET /reward/allocate/{uid}

Returns the allocation details for a given uid associated with the given App (set by the X-API-KEY).

Parameters

Path parameters

Path parameter	Description
`uid`	The unique identifier of the Allocation for this app (ex. 213134081289).

Response

You will receive the allocation details including the following fields:

Response fields	Type	Description	Condition
`uid`	String	The UID of the allocation.	Mandatory
`status`	String	The status of the allocation (pending \| done \| failed).	Mandatory
`reward_uid`	String	The UID of the reward associated.	Mandatory
`to_user_uid`	String	The UID of the user to who the rewards are allocated.	Mandatory
`amount`	String	The amount of rewards allocated	Mandatory
`nonce`	String	The unique ID of the allocation that was given	Mandatory
`created_at`	String (Timestamp)	The timestamp of the allocation creation.	Mandatory

Response example

{
  "success": true,
  "data": {
    "uid": "213134081289",
    "status": "pending",
    "reward_uid": "112144981245",
    "to_user_uid": "223144788242",
    "amount": "1.23",
    "nonce": "nonce_1",
    "created_at": "2023-08-10T14:07:14.494142Z",
  }
}

Example

The following example gets the allocation details for allocation 333333333333.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X GET \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/reward/allocation/333333333333"

Updated 8 days ago