Tournaments

Bounded poker tournaments hosted inside rooms.

List tournaments

GET

https://api.pokerworks.io

/api/v1/management/tournaments

List tournaments for a Room

List tournaments › query Parameters

roomId

string · required

Parameter roomId.

limit

number

Parameter limit.

status

string · enum

Parameter status.

Enum values:

draft

scheduled

published

cancelled

archived

List tournaments › Responses

TournamentsResponse

object[] · required

GET/api/v1/management/tournaments

curl 'https://api.pokerworks.io/api/v1/management/tournaments?roomId=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "tournaments": [
    {
      "archivedAt": "2024-08-25T15:00:00Z",
      "cancelledAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "environment": "test",
      "lifecycle": {
        "livePublishGated": true,
        "publishedAt": "2024-08-25T15:00:00Z",
        "status": "draft"
      },
      "links": {
        "joinUrl": "https://www.example.com/path/to/resource",
        "resultsUrl": "resultsUrl",
        "statusUrl": "statusUrl"
      },
      "name": "name",
      "organizationId": "organizationId",
      "output": {
        "results": {
          "available": true,
          "tournamentId": "tournamentId"
        },
        "webhookEventType": "tournament.completed"
      },
      "preset": {
        "blindStructureId": "blindStructureId",
        "key": "scheduled_mtt_nlhe_v1",
        "label": "label",
        "mode": "scheduled_mtt",
        "payoutStructureId": "payoutStructureId",
        "variant": "nlhe"
      },
      "projectId": "projectId",
      "roomId": "roomId",
      "schedule": {
        "startsAt": "2024-08-25T15:00:00Z",
        "timezone": "timezone"
      },
      "support": {
        "evidenceId": "evidenceId",
        "projectId": "projectId",
        "roomId": "roomId",
        "tournamentId": "tournamentId"
      },
      "tournamentId": "tournamentId",
      "trustMode": "human_only",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments

Create a tournament from an approved preset

Create tournament › Headers

x-idempotency-key

string · maxLength: 160

Optional retry key scoped to the organization, room, project, and environment. Reusing the same key with the same request returns the same tournament.

Create tournament › Request Body

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

Create tournament › Responses

CreateTournamentResponse

object · required

POST/api/v1/management/tournaments

curl https://api.pokerworks.io/api/v1/management/tournaments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "blindStructureId": "blindStructureId",
  "name": "name",
  "payoutStructureId": "payoutStructureId",
  "presetKey": "scheduled_mtt_nlhe_v1",
  "roomId": "roomId",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}'

Example Request Body

{
  "blindStructureId": "blindStructureId",
  "name": "name",
  "payoutStructureId": "payoutStructureId",
  "presetKey": "scheduled_mtt_nlhe_v1",
  "roomId": "roomId",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get tournament

GET

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}

Read a tournament

Get tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Get tournament › Responses

GetTournamentResponse

object · required

GET/api/v1/management/tournaments/{tournamentId}

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update tournament

PATCH

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}

Update safe draft or scheduled fields for a tournament

Update tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Update tournament › Request Body

UpdateTournamentRequest

name

string · minLength: 1 · maxLength: 120

schedule

object | null

trustMode

string · enum

Enum values:

human_only

bot_only

mixed_declared

Update tournament › Responses

UpdateTournamentResponse

object · required

PATCH/api/v1/management/tournaments/{tournamentId}

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}'

Example Request Body

{
  "name": "name",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

List tournament entries

GET

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/entries

List public-safe entries for a tournament

List tournament entries › path Parameters

tournamentId

string · required

Tournament identifier.

List tournament entries › query Parameters

limit

integer · min: 1 · max: 100

Parameter limit.

Default: 50

List tournament entries › Responses

TournamentEntriesResponse

object[] · required

object

string · enum · required

Enum values:

developer_tournament_entries

object · required

GET/api/v1/management/tournaments/{tournamentId}/entries

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/entries \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "entries": [
    {
      "admittedAt": "2024-08-25T15:00:00Z",
      "cancelledAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "displayName": "displayName",
      "entryId": "entryId",
      "entryNumber": 0.1,
      "publicParticipantId": "publicParticipantId",
      "refundedAt": "2024-08-25T15:00:00Z",
      "status": "registered",
      "support": {
        "entryId": "entryId",
        "tournamentId": "tournamentId"
      },
      "visibility": {
        "redacted": true
      }
    }
  ],
  "object": "developer_tournament_entries",
  "tournament": {
    "id": "id",
    "roomId": "roomId",
    "status": "draft"
  }
}

json

application/json

Publish tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/publish

Publish or schedule a tournament in test mode

Publish tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Publish tournament › Request Body

PublishTournamentRequest

object

Publish tournament › Responses

PublishTournamentResponse

object · required

POST/api/v1/management/tournaments/{tournamentId}/publish

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/publish \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  }
}'

Example Request Body

{
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  }
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Cancel tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/cancel

Cancel a tournament

Cancel tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Cancel tournament › Request Body

CancelTournamentRequest

reason

string · minLength: 1 · maxLength: 240

Cancel tournament › Responses

CancelTournamentResponse

object · required

POST/api/v1/management/tournaments/{tournamentId}/cancel

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/cancel \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "reason": "reason"
}'

Example Request Body

{
  "reason": "reason"
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Archive tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/archive

Archive a draft or cancelled tournament

Archive tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Archive tournament › Responses

ArchiveTournamentResponse

object · required

POST/api/v1/management/tournaments/{tournamentId}/archive

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/archive \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Tournament catalog Tournament results & verification

PokerWorks Management API

Tournaments

Bounded poker tournaments hosted inside rooms.

List tournaments

GET

https://api.pokerworks.io

/api/v1/management/tournaments

List tournaments for a Room

List tournaments › query Parameters

roomId

string · required

Parameter roomId.

limit

number

Parameter limit.

status

string · enum

Parameter status.

Enum values:

draft

scheduled

published

cancelled

archived

List tournaments › Responses

TournamentsResponse

object[] · required

GET/api/v1/management/tournaments

curl 'https://api.pokerworks.io/api/v1/management/tournaments?roomId=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "tournaments": [
    {
      "archivedAt": "2024-08-25T15:00:00Z",
      "cancelledAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "environment": "test",
      "lifecycle": {
        "livePublishGated": true,
        "publishedAt": "2024-08-25T15:00:00Z",
        "status": "draft"
      },
      "links": {
        "joinUrl": "https://www.example.com/path/to/resource",
        "resultsUrl": "resultsUrl",
        "statusUrl": "statusUrl"
      },
      "name": "name",
      "organizationId": "organizationId",
      "output": {
        "results": {
          "available": true,
          "tournamentId": "tournamentId"
        },
        "webhookEventType": "tournament.completed"
      },
      "preset": {
        "blindStructureId": "blindStructureId",
        "key": "scheduled_mtt_nlhe_v1",
        "label": "label",
        "mode": "scheduled_mtt",
        "payoutStructureId": "payoutStructureId",
        "variant": "nlhe"
      },
      "projectId": "projectId",
      "roomId": "roomId",
      "schedule": {
        "startsAt": "2024-08-25T15:00:00Z",
        "timezone": "timezone"
      },
      "support": {
        "evidenceId": "evidenceId",
        "projectId": "projectId",
        "roomId": "roomId",
        "tournamentId": "tournamentId"
      },
      "tournamentId": "tournamentId",
      "trustMode": "human_only",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Create tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments

Create a tournament from an approved preset

Create tournament › Headers

x-idempotency-key

string · maxLength: 160

Optional retry key scoped to the organization, room, project, and environment. Reusing the same key with the same request returns the same tournament.

Create tournament › Request Body

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

Create tournament › Responses

CreateTournamentResponse

object · required

POST/api/v1/management/tournaments

curl https://api.pokerworks.io/api/v1/management/tournaments \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "blindStructureId": "blindStructureId",
  "name": "name",
  "payoutStructureId": "payoutStructureId",
  "presetKey": "scheduled_mtt_nlhe_v1",
  "roomId": "roomId",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}'

Example Request Body

{
  "blindStructureId": "blindStructureId",
  "name": "name",
  "payoutStructureId": "payoutStructureId",
  "presetKey": "scheduled_mtt_nlhe_v1",
  "roomId": "roomId",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get tournament

GET

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}

Read a tournament

Get tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Get tournament › Responses

GetTournamentResponse

object · required

GET/api/v1/management/tournaments/{tournamentId}

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Update tournament

PATCH

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}

Update safe draft or scheduled fields for a tournament

Update tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Update tournament › Request Body

UpdateTournamentRequest

name

string · minLength: 1 · maxLength: 120

schedule

object | null

trustMode

string · enum

Enum values:

human_only

bot_only

mixed_declared

Update tournament › Responses

UpdateTournamentResponse

object · required

PATCH/api/v1/management/tournaments/{tournamentId}

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}'

Example Request Body

{
  "name": "name",
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  },
  "trustMode": "human_only"
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

List tournament entries

GET

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/entries

List public-safe entries for a tournament

List tournament entries › path Parameters

tournamentId

string · required

Tournament identifier.

List tournament entries › query Parameters

limit

integer · min: 1 · max: 100

Parameter limit.

Default: 50

List tournament entries › Responses

TournamentEntriesResponse

object[] · required

object

string · enum · required

Enum values:

developer_tournament_entries

object · required

GET/api/v1/management/tournaments/{tournamentId}/entries

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/entries \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "entries": [
    {
      "admittedAt": "2024-08-25T15:00:00Z",
      "cancelledAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "displayName": "displayName",
      "entryId": "entryId",
      "entryNumber": 0.1,
      "publicParticipantId": "publicParticipantId",
      "refundedAt": "2024-08-25T15:00:00Z",
      "status": "registered",
      "support": {
        "entryId": "entryId",
        "tournamentId": "tournamentId"
      },
      "visibility": {
        "redacted": true
      }
    }
  ],
  "object": "developer_tournament_entries",
  "tournament": {
    "id": "id",
    "roomId": "roomId",
    "status": "draft"
  }
}

json

application/json

Publish tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/publish

Publish or schedule a tournament in test mode

Publish tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Publish tournament › Request Body

PublishTournamentRequest

object

Publish tournament › Responses

PublishTournamentResponse

object · required

POST/api/v1/management/tournaments/{tournamentId}/publish

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/publish \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  }
}'

Example Request Body

{
  "schedule": {
    "startsAt": "2024-08-25T15:00:00Z",
    "timezone": "UTC"
  }
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Cancel tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/cancel

Cancel a tournament

Cancel tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Cancel tournament › Request Body

CancelTournamentRequest

reason

string · minLength: 1 · maxLength: 240

Cancel tournament › Responses

CancelTournamentResponse

object · required

POST/api/v1/management/tournaments/{tournamentId}/cancel

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/cancel \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "reason": "reason"
}'

Example Request Body

{
  "reason": "reason"
}

json

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Archive tournament

POST

https://api.pokerworks.io

/api/v1/management/tournaments/{tournamentId}/archive

Archive a draft or cancelled tournament

Archive tournament › path Parameters

tournamentId

string · required

Tournament identifier.

Archive tournament › Responses

ArchiveTournamentResponse

object · required

POST/api/v1/management/tournaments/{tournamentId}/archive

curl https://api.pokerworks.io/api/v1/management/tournaments/:tournamentId/archive \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "tournament": {
    "archivedAt": "2024-08-25T15:00:00Z",
    "cancelledAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "environment": "test",
    "lifecycle": {
      "livePublishGated": true,
      "publishedAt": "2024-08-25T15:00:00Z",
      "status": "draft"
    },
    "links": {
      "joinUrl": "https://www.example.com/path/to/resource",
      "resultsUrl": "resultsUrl",
      "statusUrl": "statusUrl"
    },
    "name": "name",
    "organizationId": "organizationId",
    "output": {
      "results": {
        "available": true,
        "tournamentId": "tournamentId"
      },
      "webhookEventType": "tournament.completed"
    },
    "preset": {
      "blindStructureId": "blindStructureId",
      "key": "scheduled_mtt_nlhe_v1",
      "label": "label",
      "mode": "scheduled_mtt",
      "payoutStructureId": "payoutStructureId",
      "variant": "nlhe"
    },
    "projectId": "projectId",
    "roomId": "roomId",
    "schedule": {
      "startsAt": "2024-08-25T15:00:00Z",
      "timezone": "timezone"
    },
    "support": {
      "evidenceId": "evidenceId",
      "projectId": "projectId",
      "roomId": "roomId",
      "tournamentId": "tournamentId"
    },
    "tournamentId": "tournamentId",
    "trustMode": "human_only",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Tournament catalog Tournament results & verification