Tutorials

New Recruit has many features, some can be quite complex, especially the Tournament Organiser tool

API documentation

Reports API Documentation

This API allows you to retrieve player reports and their related army lists for tournaments in the NR system.

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/reports

Request Body

Send a JSON object with at least one of the following fields:

Field	Type	Description
`id_tournament`	string	Tournament ID
`id_tourny`	string	Alternative field name for Tournament ID
`player`	string	Player login name (case-insensitive)

At least one field is required.

Example Request

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

{
  "id_tournament": "1234567890abcdef",
  "player": "Vincent"
}

Response

On success:
Returns an array of report objects matching your query. Each report includes an exported army list for each player, if available.
On error:
{ "error": "Incorrect input" }

Notes

You can use either id_tournament or id_tourny for the tournament ID; both are accepted.
If player is specified, the API searches for the player's login name (case-insensitive).
If both tournament and player are provided, the API filters by both criteria.
Exported army lists are included in the exported_list field for each player when available.
The API logs the IP address of each request internally.

Error Handling

If neither a valid tournament ID nor a player login is provided, returns:
{ "error": "Incorrect input" }

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.