ggbucks.docs
Developer portal

Developer

Read the developer console

Return only organizations where the invited account is a member, with project/game budgets, key metadata, reward rules, members and recent linked players/events. The snapshot has global limits of 500 players and 200 events across the admitted organizations. Use records pagination for complete scoped history. No player email or server secret is returned.

GET/api/developer/v1/console

Authentication

Invited developer session

An invited developer Clerk session issued through https://developers.ggbucks.com with a verified primary email and active immutable subject binding. Game keys do not authorize the console. Organization membership and role are checked separately.

# Illustrative request only. Replace IDs/tokens; events need a current occurredAt.
# Native examples require an already admitted native session/device permit.
curl --fail-with-body --max-time 15 -X GET \
  "https://api.ggbucks.com/api/developer/v1/console" \
  -H "Authorization: Bearer ${GGBUCKS_DEVELOPER_SESSION}"

Illustrative examples; replace placeholders. Use your approved developer portal session. Game keys do not authorize console requests.

Responses

200Successful sandbox response.

application/json

{
  "data": {
    "canCreateUnlimitedOrganization": false,
    "events": [],
    "games": [],
    "keys": [],
    "limits": {
      "events": 200,
      "players": 500
    },
    "members": [],
    "mode": "sandbox",
    "organizations": [],
    "players": [],
    "projects": [],
    "rules": [],
    "unitsPerDollar": 1000
  }
}
dataobjectrequired
  • Unknown fields are rejected
Show nested fields
canCreateUnlimitedOrganizationbooleanrequired
eventsobject[]required
Show item fields
createdAtstring · date-timerequired
eventIdstring · uuidrequired
eventTypestringrequired
  • Up to 64 characters
  • Pattern: ^[a-z][a-z0-9_.-]{0,63}$
gameIdstring · uuidrequired
idstring · uuidrequired
occurredAtstring · date-timerequired
organizationIdstring · uuidrequired
playerIdstring · uuidrequired
reason"daily_player_cap" | "game_budget_exhausted" | "game_paused" | "game_payout_ceiling" | "player_not_linked" | "project_budget_exhausted" | "project_payout_ceiling" | "rate_limited" | "timestamp_out_of_window" | "unknown_or_inactive_rule" | "user_unavailable" | nullrequired
Show nested fields

Accepted shape 1

"daily_player_cap" | "game_budget_exhausted" | "game_paused" | "game_payout_ceiling" | "player_not_linked" | "project_budget_exhausted" | "project_payout_ceiling" | "rate_limited" | "timestamp_out_of_window" | "unknown_or_inactive_rule" | "user_unavailable"

Accepted shape 2

null
rewardGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
status"accepted" | "rejected"required

Unknown fields are rejected.

gamesobject[]required
Show item fields
budgetGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
createdAtstring · date-timerequired
dailyPlayerCapGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
idstring · uuidrequired
maxPayoutGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
namestringrequired
organizationIdstring · uuidrequired
platform"android" | "ios" | "other" | "unity" | "unreal" | "web"required
projectIdstring · uuidrequired
spentGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
status"active" | "paused"required

Unknown fields are rejected.

keysobject[]required
Show item fields
createdAtstring · date-timerequired
gameIdstring · uuidrequired
idstring · uuidrequired
kind"public" | "secret"required
namestringrequired
organizationIdstring · uuidrequired
prefixstringrequired
publicKeynull | stringrequired
Show nested fields

Accepted shape 1

null

Accepted shape 2

string
revokedAtnull | string · date-timerequired
Show nested fields

Accepted shape 1

null

Accepted shape 2

string · date-time

Unknown fields are rejected.

limitsobjectrequired
  • Unknown fields are rejected
Show nested fields
eventsnumberrequired
playersnumberrequired

Unknown fields are rejected.

membersobject[]required
Show item fields
clerkUserIdstringrequired
createdAtstring · date-timerequired
idstring · uuidrequired
organizationIdstring · uuidrequired
role"admin" | "owner" | "viewer"required

Unknown fields are rejected.

mode"sandbox"required
organizationsobject[]required
Show item fields
balanceGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
createdAtstring · date-timerequired
idstring · uuidrequired
namestringrequired
role"admin" | "owner" | "viewer"required
unlimitedFundingbooleanrequired

Unknown fields are rejected.

playersobject[]required
Show item fields
createdAtstring · date-timerequired
externalPlayerIdstringrequired
  • At least 1 characters
  • Up to 200 characters
  • Pattern: ^[^\u0000-\u001f\u007f]*$
gameIdstring · uuidrequired
ggbucksUserIdnull | string · uuidrequired
Show nested fields

Accepted shape 1

null

Accepted shape 2

string · uuid
idstring · uuidrequired
linkedAtnull | string · date-timerequired
Show nested fields

Accepted shape 1

null

Accepted shape 2

string · date-time
organizationIdstring · uuidrequired
usernamenull | stringrequired
Show nested fields

Accepted shape 1

null

Accepted shape 2

string

Unknown fields are rejected.

projectsobject[]required
Show item fields
budgetGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
createdAtstring · date-timerequired
idstring · uuidrequired
maxPayoutGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
namestringrequired
organizationIdstring · uuidrequired
spentGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000

Unknown fields are rejected.

rulesobject[]required
Show item fields
activebooleanrequired
createdAtstring · date-timerequired
eventTypestringrequired
  • Up to 64 characters
  • Pattern: ^[a-z][a-z0-9_.-]{0,63}$
gameIdstring · uuidrequired
idstring · uuidrequired
organizationIdstring · uuidrequired
rewardGgbucksintegerrequired

Integer sandbox TEST ggbucks. 1,000 units represent one test dollar.

  • Minimum 0
  • Maximum 1,000,000,000,000
  • Greater than 0

Unknown fields are rejected.

unitsPerDollar1000required

Unknown fields are rejected.

Unknown fields are rejected.

400Invalid request or allocation/cap constraint.

application/json

errorobjectrequired
  • Unknown fields are rejected
Show nested fields
code"AUTH_UNAVAILABLE" | "DEVELOPER_ACCESS_UNAVAILABLE" | "DEVELOPER_INVITATION_REQUIRED" | "EMAIL_VERIFICATION_REQUIRED" | "INVALID_CONTENT_TYPE" | "INVALID_CURSOR" | "INVALID_PLAYER" | "INVALID_PUBLIC_KEY" | "INVALID_RECORD_QUERY" | "INVALID_REQUEST" | "INVALID_SESSION_ORIGIN" | "PAYLOAD_TOO_LARGE" | "PLATFORM_DISABLED" | "PLATFORM_UNAVAILABLE" | "UNAUTHORIZED" | "already_linked" | "conflict" | "event_conflict" | "forbidden" | "game_limit" | "game_paused" | "insufficient_funds" | "invalid_action" | "invalid_event" | "invalid_key" | "invalid_link" | "invalid_metadata" | "invalid_player" | "limit_exceeded" | "link_disabled" | "not_found" | "owner_immutable" | "project_limit" | "retry_later" | "secret_key_required" | "unauthorized" | "unlimited_funding" | "user_unavailable"required
messagestringrequired

Unknown fields are rejected.

Unknown fields are rejected.

401Missing or invalid credential/token.

application/json

errorobjectrequired
  • Unknown fields are rejected
Show nested fields
code"AUTH_UNAVAILABLE" | "DEVELOPER_ACCESS_UNAVAILABLE" | "DEVELOPER_INVITATION_REQUIRED" | "EMAIL_VERIFICATION_REQUIRED" | "INVALID_CONTENT_TYPE" | "INVALID_CURSOR" | "INVALID_PLAYER" | "INVALID_PUBLIC_KEY" | "INVALID_RECORD_QUERY" | "INVALID_REQUEST" | "INVALID_SESSION_ORIGIN" | "PAYLOAD_TOO_LARGE" | "PLATFORM_DISABLED" | "PLATFORM_UNAVAILABLE" | "UNAUTHORIZED" | "already_linked" | "conflict" | "event_conflict" | "forbidden" | "game_limit" | "game_paused" | "insufficient_funds" | "invalid_action" | "invalid_event" | "invalid_key" | "invalid_link" | "invalid_metadata" | "invalid_player" | "limit_exceeded" | "link_disabled" | "not_found" | "owner_immutable" | "project_limit" | "retry_later" | "secret_key_required" | "unauthorized" | "unlimited_funding" | "user_unavailable"required
messagestringrequired

Unknown fields are rejected.

Unknown fields are rejected.

403Admission or organization permission denied.

application/json

errorobjectrequired
  • Unknown fields are rejected
Show nested fields
code"AUTH_UNAVAILABLE" | "DEVELOPER_ACCESS_UNAVAILABLE" | "DEVELOPER_INVITATION_REQUIRED" | "EMAIL_VERIFICATION_REQUIRED" | "INVALID_CONTENT_TYPE" | "INVALID_CURSOR" | "INVALID_PLAYER" | "INVALID_PUBLIC_KEY" | "INVALID_RECORD_QUERY" | "INVALID_REQUEST" | "INVALID_SESSION_ORIGIN" | "PAYLOAD_TOO_LARGE" | "PLATFORM_DISABLED" | "PLATFORM_UNAVAILABLE" | "UNAUTHORIZED" | "already_linked" | "conflict" | "event_conflict" | "forbidden" | "game_limit" | "game_paused" | "insufficient_funds" | "invalid_action" | "invalid_event" | "invalid_key" | "invalid_link" | "invalid_metadata" | "invalid_player" | "limit_exceeded" | "link_disabled" | "not_found" | "owner_immutable" | "project_limit" | "retry_later" | "secret_key_required" | "unauthorized" | "unlimited_funding" | "user_unavailable"required
messagestringrequired

Unknown fields are rejected.

Unknown fields are rejected.

404Scoped resource not found.

application/json

errorobjectrequired
  • Unknown fields are rejected
Show nested fields
code"AUTH_UNAVAILABLE" | "DEVELOPER_ACCESS_UNAVAILABLE" | "DEVELOPER_INVITATION_REQUIRED" | "EMAIL_VERIFICATION_REQUIRED" | "INVALID_CONTENT_TYPE" | "INVALID_CURSOR" | "INVALID_PLAYER" | "INVALID_PUBLIC_KEY" | "INVALID_RECORD_QUERY" | "INVALID_REQUEST" | "INVALID_SESSION_ORIGIN" | "PAYLOAD_TOO_LARGE" | "PLATFORM_DISABLED" | "PLATFORM_UNAVAILABLE" | "UNAUTHORIZED" | "already_linked" | "conflict" | "event_conflict" | "forbidden" | "game_limit" | "game_paused" | "insufficient_funds" | "invalid_action" | "invalid_event" | "invalid_key" | "invalid_link" | "invalid_metadata" | "invalid_player" | "limit_exceeded" | "link_disabled" | "not_found" | "owner_immutable" | "project_limit" | "retry_later" | "secret_key_required" | "unauthorized" | "unlimited_funding" | "user_unavailable"required
messagestringrequired

Unknown fields are rejected.

Unknown fields are rejected.

409Replay conflict, expired link or incompatible resource state.

application/json

errorobjectrequired
  • Unknown fields are rejected
Show nested fields
code"AUTH_UNAVAILABLE" | "DEVELOPER_ACCESS_UNAVAILABLE" | "DEVELOPER_INVITATION_REQUIRED" | "EMAIL_VERIFICATION_REQUIRED" | "INVALID_CONTENT_TYPE" | "INVALID_CURSOR" | "INVALID_PLAYER" | "INVALID_PUBLIC_KEY" | "INVALID_RECORD_QUERY" | "INVALID_REQUEST" | "INVALID_SESSION_ORIGIN" | "PAYLOAD_TOO_LARGE" | "PLATFORM_DISABLED" | "PLATFORM_UNAVAILABLE" | "UNAUTHORIZED" | "already_linked" | "conflict" | "event_conflict" | "forbidden" | "game_limit" | "game_paused" | "insufficient_funds" | "invalid_action" | "invalid_event" | "invalid_key" | "invalid_link" | "invalid_metadata" | "invalid_player" | "limit_exceeded" | "link_disabled" | "not_found" | "owner_immutable" | "project_limit" | "retry_later" | "secret_key_required" | "unauthorized" | "unlimited_funding" | "user_unavailable"required
messagestringrequired

Unknown fields are rejected.

Unknown fields are rejected.

503Platform disabled or admission/database dependency temporarily unavailable; no successful mutation is implied.

application/json

errorobjectrequired
  • Unknown fields are rejected
Show nested fields
code"AUTH_UNAVAILABLE" | "DEVELOPER_ACCESS_UNAVAILABLE" | "DEVELOPER_INVITATION_REQUIRED" | "EMAIL_VERIFICATION_REQUIRED" | "INVALID_CONTENT_TYPE" | "INVALID_CURSOR" | "INVALID_PLAYER" | "INVALID_PUBLIC_KEY" | "INVALID_RECORD_QUERY" | "INVALID_REQUEST" | "INVALID_SESSION_ORIGIN" | "PAYLOAD_TOO_LARGE" | "PLATFORM_DISABLED" | "PLATFORM_UNAVAILABLE" | "UNAUTHORIZED" | "already_linked" | "conflict" | "event_conflict" | "forbidden" | "game_limit" | "game_paused" | "insufficient_funds" | "invalid_action" | "invalid_event" | "invalid_key" | "invalid_link" | "invalid_metadata" | "invalid_player" | "limit_exceeded" | "link_disabled" | "not_found" | "owner_immutable" | "project_limit" | "retry_later" | "secret_key_required" | "unauthorized" | "unlimited_funding" | "user_unavailable"required
messagestringrequired

Unknown fields are rejected.

Unknown fields are rejected.