List Players

This endpoint retrieves a list of players associated with a specific tournament. It allows you to filter players by tournament ID and optionally by competitor ID. You can also control the number of results returned and paginate through the results using a cursor.

Endpoint

GET /mm/get_players

Description

The List Players endpoint is designed to fetch players participating in a tournament. This is particularly useful for applications that need to display player information or manage player data within a tournament context.

Parameters

tournament_id (integer, required): The ID of the tournament to list players from.
competitor_id (integer, optional): Filter players by a specific competitor ID.
limit (integer, optional): The maximum number of players to return. Default is 20.
next_cursor (string, optional): A cursor for pagination to fetch the next set of results.

Responses

200 OK: Returns a list of players in JSON format.
400 Bad Request: Indicates a problem with the request parameters.
401 Unauthorized: Authentication is required and has failed or has not yet been provided.
500 Internal Server Error: An error occurred on the server.

Example Request

GET /mm/get_players?tournament_id=123&limit=10

Example Response

{
  "data": {
    "players": [
      {
        "id": 1,
        "name": "Player One",
        "competitor_id": 101,
        "tournament_id": 123
      },
      {
        "id": 2,
        "name": "Player Two",
        "competitor_id": 102,
        "tournament_id": 123
      }
    ],
    "next_cursor": "abc123"
  }
}

This enhanced documentation provides a clear understanding of how to use the endpoint effectively, including parameter details and example requests and responses.