Tournament API Documentation

This API returns detailed information about a specific tournament, including the teams and lists for each participant.

Authentication

All requests require authentication via HTTP headers.

NR-Login: Your username
NR-Password: Your password

If authentication fails, you will receive:
{ "message": "Wrong username/password, please contact NR if you need to access this API" }

Endpoint

POST https://www.newrecruit.eu/api/tournament

Request Body

Send a JSON object with the following field:

Field	Type	Required	Description
`id`	string	Yes	Tournament ID

The id field is required.

Example Request

POST /api/tournament HTTP/1.1
Host: www.newrecruit.eu
Content-Type: application/json
NR-Login: myuser
NR-Password: mypassword

{
  "id": "1234567890abcdef"
}

Response

On success:
Returns an object describing the tournament, including:
- name: Name of the tournament
- teams: Array of teams, each with team name and players (each player has name and their lists)
- type, visibility, showlists: Other tournament properties
If the tournament is not found:
Returns null.
On error or missing/invalid input:
{ "error": "Incorrect input" }
On internal error:
{ "error": "unknown error" }

Notes

The id must correspond to the tournament you wish to retrieve.
Returned teams may reflect either explicit teams or a default grouping by participants, depending on the tournament type.
If the tournament is configured with hidden lists, only the allowed lists will be included.
The API logs the user and date of each request internally.

Error Handling

If the id is missing or invalid, you will receive:
{ "error": "Incorrect input" }

If an internal error occurs, you may receive:
{ "error": "unknown error" }

Internal errors are logged, and you may receive the same response.

Contact

If you require access or encounter authentication issues, please contact the NR team.

Tutorials

API documentation