Sign in

v3

OpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB
Bulk pairings

Show a bulk pairing

Get a single bulk pairing by its ID.

get/api/bulk-pairing/{id}

Path parameters

idstring required

The ID of the bulk pairing

Example:5IrD6Gzz

Response

The bulk pairing.

idstring required
variant'standard' | 'chess960' | 'crazyhouse' | 'antichess' | 'atomic' | 'horde' | 'kingOfTheHill' | 'racingKings' | 'threeCheck' | 'fromPosition' required
pairAtinteger required
pairedAtinteger nullable required
ratedboolean required
startClocksAtinteger required
scheduledAtinteger required

Example response

{
  "id": "RVAcwgg7",
  "games": [
    {
      "id": "NKop9IyD",
      "black": "lizen1",
      "white": "thibault"
    },
    {
      "id": "KT8374ut",
      "black": "lizen3",
      "white": "lizen2"
    },
    {
      "id": "wInQr8Sk",
      "black": "lizen5",
      "white": "lizen4"
    }
  ],
  "variant": "standard",
  "clock": {
    "increment": 0,
    "limit": 300
  },
  "pairAt": 1612289869919,
  "pairedAt": null,
  "rated": false,
  "startClocksAt": 1612200422971,
  "scheduledAt": 1612203514628
}