List free-round grants

GET

/free-rounds

• Production

List your free-round grants, newest first.

Authorizations

• bearerAuth

Parameters

Query Parameters

sub_operator_ref

string

brand-01

Platform accounts only. Which brand this call acts as — the same ref the session or grant was created with. Same format and error codes as sub_operator_ref on POST /v1/sessions: omit it to use your default brand, and note that sending it empty is a 400 (E6004), not a fallback.

player_id

string

<= 128 characters

status

string

Allowed values: active partially_consumed consumed cancelled expired

Filter by grant status.

limit

integer

default: 50 >= 1 <= 200

offset

integer

0

Responses

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

401

Missing, invalid, or revoked API key.

object

error

required

object

code

required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string

/^E[0-9A-F][0-9]{3}$/

E0001

type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string

game_blocked_jurisdiction

message

required

string

request_id

Correlation ID for support escalation.

string

details

object

key

additional properties

any