Skip to content
dartpilot
Esc
↑↓navigate↵open⌘Jpreview

Get a tournament

Returns a tournament with its participants and bracket. Public tournaments are visible to any user key; private ones only to the host, participants, invited spectators and the host’s friends.

GET/tournaments/{id}
Authorization
x-api-keyAPI key · headerrequired

A user (dp_) or organization (dp_org_) API key with read scopes.

Path parameters
idstringrequired

The entity id.

Responses
200

The tournament.

idstringrequired
namestringrequired
gameTypestringrequired
formatstringrequired
statusstringrequired
visibilitystringrequired
modestringrequired
startsAtstring | nullrequired
startedAtstring | nullrequired
maxPlayersintegerrequired
min -9007199254740991 · max 9007199254740991
createdByTournamentCreatorrequired
Show properties
userIdstringrequired
displayNamestringrequired
imagestring | nullrequired
createdAtstringrequired
matchConfigTournamentMatchConfigrequired
Show properties
variantintegerrequired
min -9007199254740991 · max 9007199254740991
inModestringrequired
outModestringrequired
bullModestringrequired
bestOfintegerrequired
min -9007199254740991 · max 9007199254740991
participantsTournamentParticipant[]required
Show properties
Array of TournamentParticipant
idstringrequired
userIdstring | nullrequired
displayNamestringrequired
imagestring | nullrequired
statusstringrequired
matchesTournamentMatch[]required
Show properties
Array of TournamentMatch
idstringrequired
roundintegerrequired
min -9007199254740991 · max 9007199254740991
slotintegerrequired
min -9007199254740991 · max 9007199254740991
statusstringrequired
gameIdstring | nullrequired
participantAIdstring | nullrequired
participantBIdstring | nullrequired
participantAScoreinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
participantBScoreinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
winnerParticipantIdstring | nullrequired
participantAReadyAtstring | nullrequired
participantBReadyAtstring | nullrequired
readyDeadlineAtstring | nullrequired
decidedByHostbooleanrequired
roundsintegerrequired
min -9007199254740991 · max 9007199254740991
championParticipantIdstring | nullrequired
runnerUpParticipantIdstring | nullrequired
400

Invalid request.

messagestringrequired
401

Missing or invalid API key.

messagestringrequired
403

The API key is missing a required scope or is the wrong type for this endpoint.

messagestringrequired
404

Entity not found.

messagestringrequired
429

Rate limit exceeded. See the Retry-After header.

messagestringrequired
500

Internal server error.

messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.dartpilot.app/v1/tournaments/string' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "id": "string",
  "name": "string",
  "gameType": "string",
  "format": "string",
  "status": "string",
  "visibility": "string",
  "mode": "string",
  "startsAt": "string",
  "startedAt": "string",
  "maxPlayers": -9007199254740991,
  "createdBy": {
    "userId": "string",
    "displayName": "string",
    "image": "string"
  },
  "createdAt": "string",
  "matchConfig": {
    "variant": -9007199254740991,
    "inMode": "string",
    "outMode": "string",
    "bullMode": "string",
    "bestOf": -9007199254740991
  },
  "participants": [
    {
      "id": "string",
      "userId": "string",
      "displayName": "string",
      "image": "string",
      "status": "string"
    }
  ],
  "matches": [
    {
      "id": "string",
      "round": -9007199254740991,
      "slot": -9007199254740991,
      "status": "string",
      "gameId": "string",
      "participantAId": "string",
      "participantBId": "string",
      "participantAScore": -9007199254740991,
      "participantBScore": -9007199254740991,
      "winnerParticipantId": "string",
      "participantAReadyAt": "string",
      "participantBReadyAt": "string",
      "readyDeadlineAt": "string",
      "decidedByHost": true
    }
  ],
  "rounds": -9007199254740991,
  "championParticipantId": "string",
  "runnerUpParticipantId": "string"
}

Was this page helpful?