Get list of allocation(s) by user uid

Suggest Edits

🚧

Important:

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

Get list of allocation(s) by users

Endpoint

GET /reward/allocation?user_uid={uid}

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

Parameters

Query parameters

Query parameterDescription
user_uidThe unique identifier of the user for this app (ex. 813231035224).

Response

You will receive the list of allocation(s) details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe UID of the allocation.Mandatory
statusStringThe status of the allocation (pending | done).Mandatory
reward_uidStringThe UID of the reward associated.Mandatory
to_user_uidStringThe UID of the user to who the rewards are allocated.Mandatory
amountStringThe amount of rewards allocatedMandatory
nonceStringThe unique ID of the allocation that was givenMandatory
created_atString
(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 fetches the allocations details for user 111111111111.

# 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?user_uid=111111111111"

Updated about 1 month ago