Schemas - PokerWorks Docs

ArchiveRoomResponse

object · required

ArchiveTournamentResponse

object · required

AuditEventsResponse

object[] · required

BillingSummaryResponse

object[] · required

customer

object | null · required

organizationId

string · required

provider

string | null · enum · required

Enum values:

paddle

stripe

object[] · required

object · required

BlindStructuresResponse

object[] · required

catalogVersion

string · enum · required

Enum values:

2026-06-08.management-tournament-catalog.v2

object

string · enum · required

Enum values:

developer_blind_structures

object · required

CancelTournamentRequest

reason

string · minLength: 1 · maxLength: 240

CancelTournamentResponse

object · required

CreateBlindStructureRequest

object[] · minItems: 1 · required

name

string · minLength: 1 · maxLength: 128 · required

roomId

string · minLength: 1 · maxLength: 160 · required

estimatedDurationMinutes

integer | null

object

CreateEmbedSessionRequest

environment

string · enum · required

Enum values:

test

live

mode

string · enum · required

Enum values:

spectator

origin

string · uri · minLength: 1 · maxLength: 240 · required

productKey

string · minLength: 1 · maxLength: 120 · pattern: ^[a-z0-9-]+$ · required

projectId

string · minLength: 1 · maxLength: 160 · required

object · required

returnUrl

string · uri · minLength: 1 · maxLength: 2048

CreateEmbedSessionResponse

object · required

launchSecretTransport

string · enum · required

Enum values:

url_fragment

launchUrl

string · uri · required

CreatePayoutStructureRequest

object[] · minItems: 1 · required

maxPlayers

integer · min: 2 · max: 10000 · required

minPlayers

integer · min: 1 · max: 10000 · required

name

string · minLength: 1 · maxLength: 128 · required

roomId

string · minLength: 1 · maxLength: 160 · required

object

CreateProductKeyRequest

environment

string · enum · required

Enum values:

test

live

label

string · minLength: 1 · maxLength: 120 · required

projectId

string · minLength: 1 · maxLength: 160 · required

expiresAt

string · date-time

scopes

string[] · minItems: 1 · maxItems: 10

Enum values:

calculations:read

usage:read

org:read

CreateProductKeyResponse

object · required

secret

string · required

CreateProjectRequest

name

string · minLength: 1 · maxLength: 120 · required

allowedOrigins

string[] · maxItems: 25

CreateProjectResponse

object · required

CreateRoomRequest

environment

string · enum · required

Enum values:

test

live

name

string · minLength: 1 · maxLength: 120 · required

projectId

string · minLength: 1 · maxLength: 160 · required

allowedOrigins

string[] · maxItems: 25

object

defaultRoom

boolean

Default: false

slug

string · minLength: 1 · maxLength: 63 · pattern: ^(?:[a-z0-9]|[a-z0-9…

trustMode

string · enum

Enum values:

human_only

bot_only

mixed_declared

CreateRoomResponse

object · required

CreateTournamentRequest

name

string · minLength: 1 · maxLength: 120 · required

presetKey

string · enum · required

Enum values:

scheduled_mtt_nlhe_v1

six_max_nlhe_sng_v1

roomId

string · minLength: 1 · maxLength: 160 · required

blindStructureId

string · minLength: 1 · maxLength: 128

payoutStructureId

string · minLength: 1 · maxLength: 128

object

trustMode

string · enum

Enum values:

human_only

bot_only

mixed_declared

CreateTournamentResponse

object · required

CreateWebhookEndpointRequest

environment

string · enum · required

Enum values:

test

live

eventTypes

string[] · minItems: 1 · maxItems: 20 · required

Enum values:

tournament.completed

label

string · minLength: 1 · maxLength: 120 · required

projectId

string · minLength: 1 · maxLength: 160 · required

url

string · uri · minLength: 1 · maxLength: 2048 · required

CreateWebhookEndpointResponse

object · required

DeleteWebhookEndpointResponse

object · required

EmbedProductsResponse

object[] · required

EmitPlaygroundTournamentCompletionRequest

projectId

string · minLength: 1 · maxLength: 160 · required

fixture

string · enum

Enum values:

completed-six-max-nlhe-v1

Default: completed-six-max-nlhe-v1

object

EmitPlaygroundTournamentCompletionResponse

object · required

object[] · required

object · required

object

GetBlindStructureResponse

object · required

catalogVersion

string · enum · required

Enum values:

2026-06-08.management-tournament-catalog.v2

object

string · enum · required

Enum values:

developer_blind_structure

object · required

GetEmbedSessionResponse

object · required

GetPayoutStructureResponse

catalogVersion

string · enum · required

Enum values:

2026-06-08.management-tournament-catalog.v2

object

string · enum · required

Enum values:

developer_payout_structure

object · required

GetRingGameResponse

object · required

GetRoomResponse

object · required

GetTournamentPresetResponse

catalogVersion

string · enum · required

Enum values:

2026-06-08.management-tournament-catalog.v2

object

string · enum · required

Enum values:

developer_tournament_preset

object · required

GetTournamentResponse

object · required

GetWebhookEndpointResponse

object · required

OpenEmbedSessionRequest

launchSecret

string · pattern: ^pwes_[A-Za-z0-9_-]{… · required

origin

string · uri · minLength: 1 · maxLength: 240 · required

tableId

string · minLength: 1 · maxLength: 160 · required

OpenEmbedSessionResponse

brand

string · enum · required

Enum values:

dropinpoker

pokerdeck

pokercanyon

embedSessionId

string · required

expiresAt

string · date-time · required

mode

string · enum · required

Enum values:

spectator

productKey

string · required

ringGameId

string · required

tableId

string · required

OrganizationResponse

object[] · required

object · required

object[] · required

object · required

PayoutStructuresResponse

catalogVersion

string · enum · required

Enum values:

2026-06-08.management-tournament-catalog.v2

object

string · enum · required

Enum values:

developer_payout_structures

object[] · required

object · required

ProblemDetails

code

string · required

Stable PokerWorks error code for client branching and analytics.

detail

string · required

Human-readable explanation specific to this occurrence.

instance

string · required

URI reference that identifies the specific occurrence.

message

string · required

Stable top-level client-facing message mirrored from the problem detail.

status

integer · required

HTTP status code.

title

string · required

Short, human-readable summary of the problem type.

type

string · required

A URI reference that identifies the problem type.

correlationId

string

Correlation ID for request tracing.

retryAfterMs

integer

Retry hint in milliseconds.

stage

string

Optional readiness stage for transient failures.

ProductKeysResponse

object[] · required

ProjectsResponse

object[] · required

PublishTournamentRequest

object

PublishTournamentResponse

object · required

ReplayWebhookDeliveryResponse

object · required

RevokeProductKeyResponse

object · required

RingGamesResponse

object

string · enum · required

Enum values:

developer_ring_games

object[] · required

object · required

RoomLeaderboardResponse

object · required

object

string · enum · required

Enum values:

developer_room_leaderboard

object · required

RoomLeaderboardsResponse

object · required

object[] · required

object

string · enum · required

Enum values:

developer_room_leaderboards

object · required

RoomMembersResponse

object[] · required

roomId

string · pattern: ^pw_room_[A-Za-z0-9_… · required

RoomSummaryResponse

object · required

object

string · enum · required

Enum values:

developer_room_summary

object · required

RoomsResponse

object[] · required

RotateWebhookEndpointSecretResponse

object · required

TournamentCatalogResponse

object[] · required

catalogVersion

string · enum · required

Enum values:

2026-06-08.management-tournament-catalog.v2

object

string · enum · required

Enum values:

developer_tournament_catalog

object[] · required

object · required

object[] · minItems: 1 · required

TournamentEntriesResponse

object[] · required

object

string · enum · required

Enum values:

developer_tournament_entries

object · required

TournamentPresetsResponse

catalogVersion

string · enum · required

Enum values:

2026-06-08.management-tournament-catalog.v2

object

string · enum · required

Enum values:

developer_tournament_presets

object · required

object[] · minItems: 1 · required

TournamentResults

apiVersion

string · enum · required

Enum values:

2026-06-03

environment

string · enum · required

Enum values:

test

live

object · required

livemode

boolean · required

object

string · enum · required

Enum values:

developer_tournament_results

object[] · required

object · required

object

TournamentResultsExport

apiVersion

string · enum · required

Enum values:

2026-06-03

object · required

generatedAt

string · date-time · required

object

string · enum · required

Enum values:

developer_tournament_results_export

privacyTier

string · enum · required

Enum values:

management

public

resultProofId

string · pattern: ^rpf_[A-Za-z0-9_-]{2… · required

object · required

schemaVersion

string · enum · required

Enum values:

2026-06-08.tournament-results-export.v1

object · required

object

TournamentsResponse

object[] · required

UpdateBlindStructureRequest

estimatedDurationMinutes

integer | null

object[] · minItems: 1

name

string · minLength: 1 · maxLength: 128

provenance

object | null

UpdatePayoutStructureRequest

object[] · minItems: 1

maxPlayers

integer · min: 2 · max: 10000

minPlayers

integer · min: 1 · max: 10000

name

string · minLength: 1 · maxLength: 128

provenance

object | null

UpdateProjectRequest

allowedOrigins

string[] · maxItems: 25

name

string · minLength: 1 · maxLength: 120

UpdateProjectResponse

object · required

UpdateRoomRequest

allowedOrigins

string[] · maxItems: 25

branding

object | null

name

string · minLength: 1 · maxLength: 120

slug

string · minLength: 1 · maxLength: 63 · pattern: ^(?:[a-z0-9]|[a-z0-9…

trustMode

string · enum

Enum values:

human_only

bot_only

mixed_declared

UpdateRoomResponse

object · required

UpdateTournamentRequest

name

string · minLength: 1 · maxLength: 120

schedule

object | null

trustMode

string · enum

Enum values:

human_only

bot_only

mixed_declared

UpdateTournamentResponse

object · required

UpdateWebhookEndpointRequest

eventTypes

string[] · minItems: 1 · maxItems: 20

Enum values:

tournament.completed

label

string · minLength: 1 · maxLength: 120

status

string · enum

Enum values:

active

disabled

url

string · uri · minLength: 1 · maxLength: 2048

UpdateWebhookEndpointResponse

object · required

UsageSummaryResponse

balanceCredits

integer · required

creditsCharged

integer · min: 0 · required

environment

string · enum · required

Enum values:

test

live

organizationId

string · required

periodEnd

string · date-time · required

periodStart

string · date-time · required

projectId

string | null · required

object[] · required

totalRequests

integer · min: 0 · required

VerifyResultProofExportRequest

envelope

required

VerifyResultProofExportResponse

apiVersion

string · enum · required

Enum values:

2026-06-03

object[] · required

envelopeConsistent

boolean · required

object[] · required

object

string · enum · required

Enum values:

developer_tournament_result_proof_verification

status

string · enum · required

Enum values:

consistent

invalid

unsupported

summary

object | null · required

verifiedAt

string · date-time · required

WebhookDeliveriesResponse

object[] · required

WebhookEndpointsResponse

object[] · required