GET /v4/leagues/{leagueId}/battles/{type}/users

Purpose

Fetch the list of users participating in (or associated with) a specific battle within a league, filtered by battle type.

Endpoint: GET {{baseUrl}}/v4/leagues/:leagueId/battles/:type/users

Path variables (required)

Variable	Required	Description	Typical / allowed values
`leagueId`	Yes	League identifier the battle belongs to.	Typically a UUID/string ID stored in `{{leagueId}}` (example: use your active league id).
`type`	Yes	Battle type selector used by the API to scope which battle users are returned for.	Depends on the API. Commonly a short string/enum-like value. Use `{{type}}` from the active environment. If unsure, inspect other battle endpoints in this collection or try known values used in your workflow.

Notes:

This request uses Postman path variables :leagueId and :type, which resolve from variables such as {{leagueId}} and {{type}}.

Authentication

This endpoint is expected to require an access token.

Use Bearer Token auth:

{{token}} should be set in the active environment (Kickbase v4).

Headers

Accept: application/json

Query params / Pagination

No query parameters or pagination fields are documented for this request in the collection.

If the API supports pagination (e.g., start, max, page, limit), add them as query params and verify the response shape.

Response overview

Content-Type: expected application/json

Success: typically 200 OK

Body: expected to be a JSON payload representing a list/collection of users related to the battle. Exact schema is not documented here—use the saved example(s) or a live response to confirm fields.

Usage notes / Examples

Ensure the environment variable {{baseUrl}} points to the correct API host.

Set {{leagueId}} to the league you want to query.

Set {{type}} to the battle type you want to query.

Ensure {{token}} is a valid Bearer token.

Example request:

Common errors

401 Unauthorized: Missing/expired/invalid {{token}}.

403 Forbidden: Token valid but user not allowed to access this league/battle.

404 Not Found: Invalid leagueId, unknown type, or the battle does not exist.

400 Bad Request: Malformed path variables (e.g., empty leagueId/type) or unsupported type value.

Troubleshooting:

Re-authenticate/regenerate {{token}}.

Verify {{leagueId}} and {{type}} are set and resolve correctly.

Send a related battle endpoint (e.g., battle-by-type) to discover valid type values and confirm the battle exists.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "us": [ { "u": { "i": "123", "n": "Player", "uim": "user/123avc.jpeg", "isvf": false, "st": 0 }, "pl": 1 }, { "u": { "i": "123", "n": "Player", "uim": "user/123avc.jpeg", "isvf": false, "st": 0 }, "pl": 2 }, { "u": { "i": "123", "n": "Player", "uim": "user/123abc.jpeg", "isvf": false, "st": 0 }, "pl": 3 }, { "u": { "i": "123", "n": "Player", "uim": "user/123.jpeg", "isvf": false, "st": 0 }, "pl": 4 }, { "u": { "i": "123", "n": "Player", "uim": "user/123abc.png", "isvf": false, "st": 0 }, "pl": 5 }, { "u": { "i": "123", "n": "Player", "uim": "user/123abc.jpeg", "isvf": false, "st": 0 }, "pl": 6 } ] }

GET /v4/leagues/{leagueId}/battles/{type}/users

Purpose#

Path variables (required)#

Authentication#

Headers#

Query params / Pagination#

Response overview#

Usage notes / Examples#

Common errors#

Request

Responses