REST API

The REST API provides interfaces for most BracketCloud functionality. This documentation is designed for those interested in creating and managing tournaments from your own applications.

General notes

SSL only

We require that all requests are made over SSL. Ensure your request URL is pointing at HTTPS.

Version numbers

You must include the API version number with each callback. The current version of our API is version 1.0.

API Keys

To use the BracketCloud API you need to have an application key. We use this to authenticate your user account and track API usage. You can find your API Key by going to your Account Settings page. Your API Key must be included as a parameter with all requests to our API. For GET requests, add it to the URL (see below) or in the JSON POST body for other requests.

e.g. https://bracketcloud.com/api/1.0/tournaments/288?api_key={YOUR API KEY}
Rate limiting

A maximum of 540 requests per 3 hours is permitted per remote IP (except white label solutions). You can see your current Rate limit in the response headers X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset.

Response formats

This API only returns JSON.

Parameters format

Any parameters you send to our API callbacks must be in a JSON format.

Note: For GET requests, all parameters are strings and booleans should be expressed as 'true' or 'false'.

Return codes
CodeDescription
200 OK
204 OK. Nothing to be returned.
400 Bad input parameter. See the error message in the body of the returned JSON for details.
403 You do not have access to the callback.
404 Incorrect URL.
405 The request method used is not supported by the callback.
429 You have exceeded your API rate limit.

Tournaments

Tournaments are the flesh and blood of BracketCloud. Depending on the type of tournament, functionality may change. Please read about our tournament types to learn more.

Show

Description
Returns a single tournament.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid
Method
GET
Parameters
tid (URL)
required		 The numerical ID of the desired tournament.
Example response
{
   "title":"Untitled",
   "status":2,
   "type":"bracket",
   "created":1366357626,
   "changed":1366357626,
   "matches":[
      {
         "mid":1,
         "timestamp":0,
         "winner":0,
         "round":1,
         "group_id":0,
         "comment_count":0,
         "file_count":0,
         "competitors":[
            {
               "mid":1,
               "weight":0,
               "position":1,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            },
            {
               "mid":1,
               "weight":1,
               "position":8,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            }
         ],
         "winner_mid":5,
         "winner_weight":0,
         "position_0":1,
         "position_1":8,
         "tid":187
      },
      {
         "mid":2,
         "timestamp":0,
         "winner":0,
         "round":1,
         "group_id":0,
         "comment_count":0,
         "file_count":0,
         "competitors":[
            {
               "mid":2,
               "weight":0,
               "position":5,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            },
            {
               "mid":2,
               "weight":1,
               "position":4,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            }
         ],
         "winner_mid":5,
         "winner_weight":1,
         "position_0":5,
         "position_1":4,
         "tid":187
      },
      {
         "mid":3,
         "timestamp":0,
         "winner":0,
         "round":1,
         "group_id":0,
         "comment_count":0,
         "file_count":0,
         "competitors":[
            {
               "mid":3,
               "weight":0,
               "position":3,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            },
            {
               "mid":3,
               "weight":1,
               "position":6,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            }
         ],
         "winner_mid":6,
         "winner_weight":0,
         "position_0":3,
         "position_1":6,
         "tid":187
      },
      {
         "mid":4,
         "timestamp":0,
         "winner":0,
         "round":1,
         "group_id":0,
         "comment_count":0,
         "file_count":0,
         "competitors":[
            {
               "mid":4,
               "weight":0,
               "position":7,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            },
            {
               "mid":4,
               "weight":1,
               "position":2,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            }
         ],
         "winner_mid":6,
         "winner_weight":1,
         "position_0":7,
         "position_1":2,
         "tid":187
      },
      {
         "mid":5,
         "timestamp":0,
         "winner":0,
         "round":2,
         "group_id":0,
         "comment_count":0,
         "file_count":0,
         "competitors":[
            {
               "mid":5,
               "weight":0,
               "position":0,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            },
            {
               "mid":5,
               "weight":1,
               "position":0,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            }
         ],
         "winner_mid":7,
         "winner_weight":0,
         "loser_mid":8,
         "loser_weight":0,
         "tid":187
      },
      {
         "mid":6,
         "timestamp":0,
         "winner":0,
         "round":2,
         "group_id":0,
         "comment_count":0,
         "file_count":0,
         "competitors":[
            {
               "mid":6,
               "weight":0,
               "position":0,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            },
            {
               "mid":6,
               "weight":1,
               "position":0,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            }
         ],
         "winner_mid":7,
         "winner_weight":1,
         "loser_mid":8,
         "loser_weight":1,
         "tid":187
      },
      {
         "mid":7,
         "timestamp":0,
         "winner":0,
         "round":3,
         "group_id":0,
         "comment_count":0,
         "file_count":0,
         "competitors":[
            {
               "mid":7,
               "weight":0,
               "position":0,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            },
            {
               "mid":7,
               "weight":1,
               "position":0,
               "score":null,
               "tid":187,
               "comment":null,
               "icon":null
            }
         ],
         "tid":187
      }
   ],
   "participants":[

   ],
   "admins":[

   ],
   "location":null,
   "location_url":null,
   "twitch":null,
   "size":8,
   "waiting_list":true,
   "signup":true,
   "password":false,
   "deadline":0,
   "form":null,
   "score_entry":true,
   "fee_amount":0,
   "fee_currency":null,
   "fee_email":null,
   "rounds":null,
   "body":[

   ],
   "format":1,
   "bronze_match":false,
   "tid":187,
   "owner":"admin",
   "owner_uid":1,
   "fields": [{ "fid": 123, "label": "my custom field", "type": "text" }],
   "picture_original":"http:\/\/cdn.bracketcloud.com\/tournaments\/pictures\/default.png",
   "picture_small":"http:\/\/cdn.bracketcloud.com\/tournaments\/pictures\/small\/default.png",
   "picture_medium":"http:\/\/cdn.bracketcloud.com\/tournaments\/pictures\/medium\/default.png"
}

Create

Description
Creates a new tournament.
URL
https://bracketcloud.com/api/1.0/tournaments
Method
POST
Parameters
type
required		 The type of tournament you want to create. Available values: bracket (default), round_robin, ladder.
title The title of your tournament. Maximum length is 64 characters. If this is left blank, the tournament is named "Untitled" by default.
category If relevant, the category of this tournament. View our full category list for more details.
body A description of your tournament. You can use HTML here. Allow tags are 
<img> <a> <em> <strong> <cite> <blockquote> <code> <ul> <ol> <li> <dl> <dt> <dd>
status The published status of your tournament. 0 = Private, 1 = People with the link only, 2 = Public (default).
teams Set this to true or false (default) to determine if participants of this tournament are teams or individual players.
location The location that the tournament is being held. This is a string value, maximum length 255.
location_url A URL for the tournament location. For example, a link to the venue on Google Maps or its home page.
size

Set this to the number of participants you wish to cater for. Once the number of participants reaches this value no more subsequent participants can be added.
signup Set this to true (default) or false to determine if users can sign up to the tournament themselves.
password You can set a password that users must enter before they can signup. Maximum length is 16 characters.
deadline You can set a deadline for participant signups. Value must be a unix timestamp (Seconds elapsed since the Unix Epoch).
score_entry Set this to true (default) or false to determine if users can enter match results themselves. If set to false, only admins can match results.
twitch This value allows you to link a Twitch TV channel to your tournament. By doing so, visitors to your tournament can view the live stream right from the tournament page.
twitter_ticker Set this to true or false (default) to determine if the tournament owners linked Twitter account is used to automatically post match score updates. Learn more here
fee_email You can accept registration fees from participants in order to join your tournament. Set this to your PayPal email address.
fee_amount When setting the fee_email parameter, this value must be set. This is the integer amount of the required registration fee for participants to join this tournament.
fee_currency When setting the fee_email parameter, this value must be set. This must be set to the currency that participants will pay in. It is very important that you ensure your PayPal account is setup to accept payments in this currency. Acceptable values are AUD, CAD, CZK, DKK, EUR, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PHP, PLN, GBP, SGD, SEK, CHF, TWD, THB, USD.
rounds
brackets and round robin only

This can be used to set round comments. Warning: Setting this will overwrite any previous entered values.

Bracket - An associative array of rounds keyed by the bracket tab: 'winners', 'losers' or 'final'. (losers and final can only be used with double elimination brackets).

Round Robin - An associative array of rounds keyed by group ID.

Each round must be an associative array of round comment strings keyed by round number.

Example structure

{
   "winner":{
      "2":"Second round comment",
      "3":"Third round comment"
   },
   "loser":{
      "1":"Just a single comment!"
   }
}
format

This value can be used to set the tournament format. The meaning of the value changes based on the tournament type.

Bracket - The bracket structure (1 = Single Elimination, 2 = Double Elimination)

Round robin - The number of times group participants play each other (1 = Once, 2 = Twice)

bronze_match
SE brackets only

 A bronze match can be played to determine the third and fourth places of a tournament. For single elimination brackets, you can set this to true or false (default).

groups
Round Robin only

 Use this to set the integer number of groups in the round robin tournament.

win_points
Round Robin only

 Group points awarded to a participant for winning a match. Default is 3.

draw_points
Round Robin only

 Group points awarded to a participant for drawing a match. Default is 1.

loss_points
Round Robin only

 Group points awarded to a participant for losing a match. Default is 0.

multiplier
Round Robin only

 You can use this value as an alternative scoring system for Round Robin tournaments. When set, this value is used to multiply the score to determine points won. For example if there was a match with result of Team A = 2, Team B = 1 and a multiplier of 3 then Team A would be awarded 6 points and Team B would be awarded 3. Default is 0 but if it is set then win_points, draw_points and loss_points wil all be ignored.
Response
Returns the new tournament object. See GET tournaments/:tid for an example response.

Update

Description
Updates a given tournament.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid
Method
PUT
Parameters
tid (URL)
required		 The numerical ID of the tournament to update.
title See POST tournaments for details.
body See POST tournaments for details.
status See POST tournaments for details.
location See POST tournaments for details.
location_url See POST tournaments for details.
size

See POST tournaments for details.

Warning: By changing a tournament size, tournament matches will be reset. Participant positions will be automatically re-ordered to fit in the new tournament size. However, if there is not enough space, remainder participants will be permanently deleted.
signup See POST tournaments for details.
password See POST tournaments for details.
deadline See POST tournaments for details.
form See POST tournaments for details.
score_entry See POST tournaments for details.
twitch See POST tournaments for details.
twitter_ticker See POST tournaments for details.
fee_email See POST tournaments for details.
fee_amount See POST tournaments for details.
fee_currency See POST tournaments for details.
format

See POST tournaments for details.

Warning: By changing a tournament format, tournament matches will be reset.
bronze_match
SE brackets only		 See POST tournaments for details.

groups
Round Robin only

 See POST tournaments for details.

win_points
Round Robin only

 See POST tournaments for details.

draw_points
Round Robin only

 See POST tournaments for details.

loss_points
Round Robin only

 See POST tournaments for details.

multiplier
Round Robin only

 See POST tournaments for details.
Response
Returns the updated tournament object. See GET tournaments/:tid for an example response.

Delete

Description
Deletes a tournament permanently.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid
Method
DELETE
Parameters
tid (URL)
required		 The numerical ID of the tournament to reset.
Description
Returns a collection of tournaments matching specified criteria.
URL
https://bracketcloud.com/api/1.0/tournaments
Method
GET
Parameters
tid A comma delimited list of tournament ids. Only tournaments matching these IDs will be returned.
type A tournament type, e.g. bracket.
category Use this to filter tournaments by a specific category. View our full category list for more details.
since Returns tournaments created since this date. Value must be a unix timestamp (Seconds elapsed since the Unix Epoch).
until Returns tournaments created until this date. Value must be a unix timestamp (Seconds elapsed since the Unix Epoch).
signup Set this to true or false to restrict results on whether sign up is enabled or not.
participant You can set this to a user ID to restrict results to those that this user is a participant of.
owner You can set this to a user ID to restrict results to those that this user created.
limit The number of tournaments to return. The maximum is 100. The default is 30.
sort

A comma delimited list of values to order the tournament by. Each value must be in the format field-order.

Example:

title-DESC,tid-ASC
full_objects Set this to true to return full tournament objects. The default is false.
Example response
{
  "22": {
    "tid": 22,
    "title": "My first tournament"
  },
  "23": {
    "tid": 23,
    "title": "Test tournament"
  }
}

Participants

Participants are the players or teams of tournaments on BracketCloud. Optionally, participants can be linked to an authenticated user on our website allowing them to enter scores for their tournament matches themselves.

Create

Description
Adds a new participant to a tournament.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/participants
Method
POST
Parameters
tid (URL)
required		 The numerical ID of the tournament to add the participant to.

position
required

Position is the unique identifier for a participant. Generally speaking, it is used for ordering participants. This value is also known as the seed where the stronger the participant, the higher the position (e.g. 1 being the strongest). The acceptable range is between 1 and the tournament size. Once a participant has been created in brackets, they will automatically be assigned their respective matches in the tournament. This value does not have any effect on the order of participants in round robin groups. Please note that you can not overwrite an existing participants, they must be destroyed first using DELETE tournaments/:tid/participants/:position

Warning: By creating a new participant, relative tournament matches will be reset (all matches for brackets, same groups matches for round robin). To alter participants without reseting tournament matches, see PUT tournament/:tid/participants/:tid
uid The unique user ID to associate with this participant. The users name will override any custom value set in name. Either the name or uid parameter must be provided.
name A name to represent the new participant. Max length is 60 characters. Either the name or uid parameter must be provided.
icon The icon used to represent the participant in this tournament. View our full icon list for more details.
group_id Round robin only - The group to assign to the participant. This value is required for creating round robin tournament participants.
field_data

If fields are set for your tournament then you can use this parameter for setting the participants field values in an array.

Example structure

[
   {
      "fid":213,
      "value":"My answer goes here!"
   },
   {
      "fid":214,
      "value":"My other answer goes here!"
   }
]
members

If the tournament boolean teams is set to true, you may use this parameter to set this participants member list.

Example structure

[
   {
      "name":"Joe",
      "icon":"gb",
      "field_data":[
         {
            "fid":"214",
            "value":"Joes member field value"
         }
      ]
   },
   {
      "name":"Pablo",
      "icon":"es"
   }
]
Example response
{
  "comment": null,
  "created": 1360823188,
  "form_data": "",
  "icon": null,
  "name": "test",
  "position": 4,
  "rank": "",
  "status": 1,
  "tid": 50,
  "uid": 0
}

Create bulk

Description
Add a bulk of participants to a tournament at once. This uses the same URL as POST participants above but by simply adding the names participant you can POST participants in a bulk. Please note you cannot currently mix parameters from this method and the one above.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/participants
Method
POST
Parameters
tid (URL)
required		 The numerical ID of the tournament the participant resides.

names
required

An array of participant names (as strings) to add.
Example response
{
  "1": {
    "comment": null,
    "created": "1360819058",
    "form_data": null,
    "icon": null,
    "name": "joe",
    "nid": "50",
    "position": "1",
    "rank": "",
    "status": "1",
    "uid": "0"
  },
  "2": {
    "comment": null,
    "created": "1360819058",
    "form_data": null,
    "icon": null,
    "name": "bob",
    "nid": "50",
    "position": "2",
    "rank": "",
    "status": "1",
    "uid": "0"
  },
  "3": {
    "comment": null,
    "created": "1360819058",
    "form_data": null,
    "icon": null,
    "name": "jeff",
    "nid": "50",
    "position": "3",
    "rank": "",
    "status": "1",
    "uid": "0"
  }
}

Update

Description
Updates a tournament participant.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/participants/:position
Method
PUT
Parameters
tid (URL)
required		 The numerical ID of the tournament the participant resides.
position (URL)
required		 The position of the participant. See POST tournament/:tid/participants/:position for details.
new_position

Use this parameter to move the participant to a different position in your tournament. If the target position already has a participant, the participants will be swapped.

Warning: If the target position has no participant, all tournament match results entered will be reset.
uid See POST tournaments/:tid/participants/:position for details.
status This can be used to re-enable disabled participants by setting to 1.
name See POST tournaments/:tid/participants/:position for details.
icon See POST tournaments/:tid/participants/:position for details.
form_data See POST tournaments/:tid/participants/:position for details.
comment See POST tournaments/:tid/participants/:position for details.
group_id See POST tournaments/:tid/participants/:position for details.
Reponse
Returns the updated participant as an object. See POST tournaments/:tid/participants/:position for an example response.

Update all

Description
Updates an entire tournaments participants. Currently this only allows shuffling participants.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/participants
Method
PUT
Parameters
tid
required		 The numerical ID of the tournament to shuffle.
shuffle

Set this to true to shuffle participants. Participant positions are completely randomized.

Warning: This will remove any tournament matches and scores.
Example response
[
  {
    "comment": null,
    "created": 1360815355,
    "form_data": "",
    "icon": null,
    "name": "Bob",
    "position": 1,
    "rank": "",
    "status": 1,
    "tid": 50,
    "uid": 0
  },
  {
    "comment": null,
    "created": 1360806802,
    "form_data": "",
    "icon": null,
    "name": "Joe",
    "position": 2,
    "rank": "",
    "status": 1,
    "tid": 50,
    "uid": 0
  }
]

Delete

Description
Removes participants from a tournament.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/participants/:position
Method
DELETE
Parameters
tid (URL)
required		 The numerical ID of the tournament the participant resides.

position (URL)
optional

Set this to the position of a participant to delete. If the participant has played any matches then to ensure tournament data remains intact, their status is set to 0 which does not delete the participants data or any matches that they played in. By calling DELETE tournaments/:tid/matches any participants with a status of 0 will be automatically deleted.

Alternatively, leaving this parameter blank will permanently remove all tournament participants regardless of their status.

Delete all

Description
Removes all participants from a tournament. This will, in turn, reset all tournament matches and their scores.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/participants
Method
DELETE
Parameters
tid (URL)
required		 The numerical ID of the tournament.

Matches

The number of matches played in a tournament depends on its type. Please read about our tournament types to learn more.

Create bulk

Description
Round Robin only - Use this request method to automatically create all matches for a specific round robin group.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/matches
Method
POST
Parameters
tid (URL)
required		 The numerical ID of the tournament.
group_id
required		 The round robin group to create matches for.
Example response
{
  "comment": "A new comment!",
  "mid": 1,
  "participants": [
    {
      "mid": 1,
      "position": 1,
      "score": 0,
      "tid": 50,
      "weight": 0
    },
    {
      "mid": 1,
      "position": 8,
      "score": 0,
      "tid": 50,
      "weight": 1
    }
  ],
  "position_0": 1,
  "position_1": 8,
  "round": 1,
  "tid": 50,
  "timestamp": 0,
  "winner": 0,
  "winner_mid": 5,
  "winner_weight": 0
}

Update

Description
Updates a tournament match. Use this request method to add match scores and set a match winner.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/matches/:mid
Method
PUT
Parameters
tid (URL)
required		 The numerical ID of the tournament.

mid (URL)
required

The numerical ID of the match.

Note: The match ID is not a global unique identifier. It is relative to the tournament ID, starting at 1. Therefore, a match is unique based on both its tid and mid.
timestamp You can associate a date with matches. Values must be a unix timestamp (Seconds elapsed since the Unix Epoch).
winner Identifies the winning competitor of this match. This value should be the participants position number.
scores

Use this to set the scores of the match competitors. Separate sets/games by a comma and scores by a dash, in order of competitors. e.g. 2-0,1-2,1-0

Note: Setting the scores of a match will not automatically set the winner. You must explicitly set the winner of a match.

Warning: Updating scores will overwrite any scores previously submitted for this match.
data Use this for custom data related to the match. This should be an object of keys and values. Reserved keys are dota2_match_id.
Example response
{
  "mid": 1,
  "participants": [
    {
      "mid": 1,
      "position": 1,
      "score": 0,
      "tid": 50,
      "weight": 0
    },
    {
      "mid": 1,
      "position": 8,
      "score": 0,
      "tid": 50,
      "weight": 1
    }
  ],
  "position_0": 1,
  "position_1": 8,
  "round": 1,
  "tid": 50,
  "timestamp": 0,
  "winner": 0,
  "winner_mid": 5,
  "winner_weight": 0
}

Delete

Description
Deletes all tournament matches. In practice, this callback actually resets a tournaments matches. This sets all matches scores and competitors back to 0.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/matches
Method
DELETE
Parameters
tid (URL)
required		 The numerical ID of the tournament.
group_id
Round Robin only		 Setting this will reset only a single groups within a round robin tournament and will not affect any other group.

Match Comments

BracketCloud users can comment on matches. This can be useful for activities such as discussing match schedules and rules.

Show

Description
Retrieves a single match comment.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/matches/:mid/comments/:cid
Method
GET
Parameters
tid (URL)
required		 The numerical ID of the tournament.

mid (URL)
required

The numerical ID of the match.

Note: The match ID is not a global unique identifier. It is relative to the tournament ID, starting at 1. Therefore, a match is unique based on both its tid and mid.

cid (URL)
required

The numerical ID of the comment.
Example response

Show all

Description
Retrieves all of a matches comments.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/matches/:mid/comments
Method
GET
Parameters
tid (URL)
required		 The numerical ID of the tournament.

mid (URL)
required

The numerical ID of the match.

Note: The match ID is not a global unique identifier. It is relative to the tournament ID, starting at 1. Therefore, a match is unique based on both its tid and mid.
Example response

Create

Description
Posts a new match comment.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/matches/:mid/comments
Method
POST
Parameters
tid (URL)
required		 The numerical ID of the tournament.
mid (URL)
required		 The numerical ID of the match.
comment
required		 A string comment to post. Max length is 140 characters.

Delete

Description
Deletes a single match comment. In practice, this callback actually resets a tournaments matches. This sets all matches scores and competitors back to 0.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/matches/:mid/comments/:cid
Method
DELETE
Parameters
tid (URL)
required		 The numerical ID of the tournament.
mid (URL)
required		 The numerical ID of the match.
cid (URL)
required		 The numerical ID of the match comment.

Admins

Tournament admins can be set by the tournament owner. A tournament admin has access to edit tournament settings, participants and submit match results. Admins must own a BracketCloud user account.

Create

Description
Adds a new tournament admin. You must be the owner (creator) of the tournament to be able to add new admins.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/admins/:uid
Method
POST
Parameters
tid
required		 The numerical ID of the tournament.

uid
required

 The unique user ID of the tournament admin to add. You can use GET users to find out a users uid.
Example response
{
  "created": 1360815553,
  "nid": "50",
  "uid": "8"
}

Delete

Description
Deletes a tournament admin. You must be the owner (creator) of the tournament to be able to delete admins.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/admins/:uid
Method
DELETE
Parameters
tid
required		 The numerical ID of the tournament.

uid
required

 The unique user ID of the tournament admin to delete.

Users

These callbacks allow you to interact with BracketCloud user accounts.

Description
Returns a collection of BracketCloud users matching specified criteria. You must include either uid or name parameters.
URL
https://bracketcloud.com/api/1.0/users
Method
GET
Parameters

name

 Search for users based on a portion of their name. Minimum length is 3 characters and maximum is 64.

uid

 Search for users based on their user ID. This will return only a single entry.
Example response
{
  "1": {
    "created": 1358840404,
    "name": "PotatoMan",
    "uid": 1
  }
}

Custom Fields

Tournament custom fields definitions. Custom fields of a tournament are retrieved in the fields property of Tournament Show method

Create

Description
Adds a new tournament custom field. You must be an admin of the tournament to be able to create custom fields.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/fields
Method
POST
Parameters
tid
required		 The numerical ID of the tournament.

label
required

 The label of the Field (a text to be shown to users)

type
required

 An string, one of these values: 'text', 'select', 'checkbox', 'email'

settings
required if type is select

 An array of strings, with the values for the field. This will be presented as a Select box

display
optional

 Boolean: true to be a public field and false to be only for admins

signup
optional

 Boolean: true to be show the field at Signup form

required
optional

 If signup is true. Set this field to true to be required on signup

editable
optional

 Set this field to true if let users edit their own value

members
optional

 Set this field to true to separate a value for each member
Example response
{
      "fid": 123,
      "label": "custom field label",
      "type": "text",
      "settings": null,
      "display": true,
      "signup": false,
      "required": false,
      "editable": false,
      "members": false,
      "tid": 124
}

Update

Description
Updates a custom field definition.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/fields/:fid
Method
PUT
Parameters
Refer to Create to paramaters
Example response
Refer to Create for an example response

Delete

Description
Deletes a Custom Field definition.
URL
https://bracketcloud.com/api/1.0/tournaments/:tid/fields/:fid
Method
DELETE
Parameters

Acceder

Esqueceches o teu contrasinal?