Skip to content

List account rewards

GET
/rewards
curl --request GET \
--url 'https://api.proxyrequest.com/api/v1/rewards?level=diamond' \
--header 'Authorization: Bearer <token>'

Returns referral and campaign rewards earned by the authenticated account, ordered from newest to oldest.

level
string
Allowed values: diamond gold silver standard
  • standard - Standard * silver - Silver * gold - Gold * diamond - Diamond
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

user__email
string
user__id
string format: uuid

The operation completed successfully.

Media typeapplication/json
object
count
required
integer
next
string format: uri
nullable
previous
string format: uri
nullable
results
required
Array<object>
object
id
string
<= 36 characters
email
required
string
created
required
string format: date-time
balance
Balance (cents)
integer
<= 2147483647
data
Data (bytes)

The amount of data in bytes.

integer format: int64
<= 1000000000000000
status

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package’s data or proxies. * pending - Pending * paid - Paid * review - Review * cancelled - Cancelled

string
Allowed values: pending paid review cancelled
description

Description of the reward, used to include payout details.

string
level
  • standard - Standard * silver - Silver * gold - Gold * diamond - Diamond
string
Allowed values: standard silver gold diamond
Examples
Exampleexample

Example response

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"email": "[email protected]",
"created": "2026-07-01T12:30:00Z",
"balance": 1,
"data": 1073741824,
"status": "pending",
"description": "description",
"level": "standard"
}
]
}

The request is malformed or violates a business rule.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleValidationError

Validation error

{
"non_field_errors": [
"The request could not be processed."
],
"translation": "errors.request.invalid"
}

Authentication credentials are missing, expired, or invalid.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExampleAuthenticationRequired

Authentication required

{
"detail": "Authentication credentials were not provided."
}

The authenticated account cannot perform this operation.

Media typeapplication/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object
detail
string
non_field_errors
Array<string>
translation

Stable translation key suitable for client localisation.

string
key
additional properties
One of:
string
Examples
ExamplePermissionDenied

Permission denied

{
"detail": "You do not have permission to perform this action."
}