---
title: "List players"
method: GET
path: "/v1/reports/players/list/"
tags: ["Reports"]
---

# List players

`GET /v1/reports/players/list/`

## Request

- Base URL: `https://api.educaplay.com`
- URL: `https://api.educaplay.com/v1/reports/players/list/`
- Auth: HTTP bearer

Paginated list of the players who have completed the user's activities, with their aggregated results. Pages hold up to 50 items.

## Query parameters

- `filter` 'lastDay' | 'lastWeek' | 'lastYear' | 'custom'
- `tss` string
- `tse` string
- `players` '' | 'guests'
- `ids` string
- `page` integer
- `q` string

## Response `200`

Report data for the requested period.

- PlayersListResponse
  - `items` PlayerListItem[]
    - `type` string: `registered` or `anonymous`.
    - `id` string
    - `key` string: Player key to use in the `ids` filter and in the per-player endpoints.
    - `name` string
    - `photo` string
    - `accuracy` integer: Average accuracy over the period, from 0 to 100.
    - `games` integer: Number of activities completed.
    - `lastPlayed` integer: Most recent play. Unix timestamp in seconds.
    - `best` integer: Best score achieved.
    - `totalTime` integer: Total time spent, in seconds.
  - `hasMore` boolean
  - `page` integer
  - `_links` HalLink[]
    - `rel` string, required
    - `href` string, uri, required

## Other responses

- `401`: Authentication is missing or the Bearer token is invalid.
- `429`: The request rate limit for the account has been exceeded. Limits depend on the subscription plan (Basic 120, Advanced 300, Academic 600 and Commercial 1200 requests per minute) and are measured over a fixed 60 second window. Wait the number of seconds given in the `Retry-After` header before retrying.

## Changes

- **2026-10-19** `e31d97013d0d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/educaplay/apis/educaplay-api/changes/v1/reports/players/list/get.md)

---

[API](https://skmtc.dev/educaplay/apis/educaplay-api.md) · [All operations](https://skmtc.dev/educaplay/apis/educaplay-api/llms.txt) · [OpenAPI document](https://skmtc.dev/educaplay/apis/educaplay-api/revisions/e31d97013d0d?raw)