Skip to content
Developer Hub

Open app

List free-round grants

GET
/free-rounds

List the operator’s free-round grants (our records), newest first.

Platform accounts must send sub_operator_ref and get that brand’s grants. A platform-wide view across all brands is not available yet.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
sub_operator_ref
string
brand-01

Platform accounts only. Which brand’s grants to list - grants are keyed on the brand’s identity. Omitting it lists your default brand’s grants; sending it from a non-platform key is a 400 (E6006); with no default brand provisioned the call is a 409 (E6010), and under require_sub_operator_ref omitting it is a 400 (E6005). Omit it to get the default brand; sending it empty is a 400 (E6004), not a fallback - see sub_operator_ref on POST /v1/sessions for why the two differ. List one brand at a time; a platform-wide aggregate is not available yet.

player_id
string
<= 128 characters
status
string
Allowed values: pending_issue issue_failed active partially_consumed consumed pending_cancel cancel_failed cancelled expired observed
limit
integer
default: 50 >= 1 <= 200
offset
integer
0

Responses

Section titled “Responses”

200

Section titled “200”

List of grants.

object
count
integer
grants
Array<object>
object
grant_id
string format: uuid
status
string
provider_code
string
player_id
string
currency
string
count
integer
rounds_used
integer
start_at
string format: date-time
end_at
string format: date-time
created_at
string format: date-time
games
Array<object>
object
game_id
string format: uuid
provider_game_id
string
count
integer
rounds_used
integer
provider_grant_ref

Per-game provider ref: Apparat voucherId; for Mobule the freerounds_id we minted (32 lowercase hex), carried on the player’s game launch and activated by Mobule once.

string
nullable
status
string
Allowed values: pending_issue issue_failed active partially_consumed consumed pending_cancel cancel_failed cancelled expired observed
error
string
nullable

401

Section titled “401”

Missing, invalid, or revoked API key.

object
error
required
object
code
required

Machine-parseable error code. See https://hub.aggregator.gg/error-reference/.

string
/^(E[0-9A-F][0-9]{3}|PROVIDER_ACCESS_REQUIRED|PROVIDER_ACCESS_UNAVAILABLE)$/
E0001
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any