List Sessions

Retrieve a paginated list of sessions. All filter parameters are optional — if none are provided, all sessions are returned with pagination.

Request

curl -X GET "https://api.series.hr/sessions/list?page=1&status=upcoming" \
  -H "apikey: YOUR_API_KEY"

Date range example

curl -X GET "https://api.series.hr/sessions/list?start=2024-01-01&end=2024-01-31&status=completed" \
  -H "apikey: YOUR_API_KEY"

Single date example

curl -X GET "https://api.series.hr/sessions/list?date=2024-01-15" \
  -H "apikey: YOUR_API_KEY"

Parameters

integer

Page number (default: 1)

string

Filter by session status. One of: upcoming, ongoing, completed, cancelled

string

Filter by a single date (YYYY-MM-DD). Cannot be combined with start/end.

string

Start of date range (YYYY-MM-DD). Use with end.

string

End of date range (YYYY-MM-DD). Use with start.

string

Filter by host user ID

Response

{
  "success": true,
  "data": {
    "WorkspaceId": "workspace_abc123",
    "Page": 1,
    "Sessions": [
      {
        "SessionId": "session_1234567890_abc12345678",
        "WorkspaceId": "workspace_abc123",
        "Title": "Training Session",
        "Host": "714760171",
        "PlaceId": "1234567890",
        "ServerId": null,
        "Scheduled": "2024-01-20T15:00:00.000Z",
        "Delayed": false,
        "Status": "upcoming",
        "Claimable": true,
        "AutoRankPassers": true,
        "Duration": 60,
        "Recurring": false,
        "RecurrenceId": null,
        "CustomRoles": {
          "Trainer": {
            "MinRank": 25,
            "Permissions": {
              "ChangeSessionStatus": false,
              "PassOrFailAttendees": true,
              "ModifyAttendance": true
            },
            "Slots": {
              "VACANT_0": { "Attended": false },
              "VACANT_1": { "Attended": false }
            }
          }
        }
      }
    ]
  }
}

The CustomRoles field is only included for Premium/Enterprise workspaces that have custom roles configured on their sessions.

Introduction & basics

Basic

Activity

Activity Credits

Sessions

Attendance

Game Moderation

Applications

Members

Time-Off

Hotel

Food & Beverage

Ranking

Flights

Tickets

Request

Date range example

Single date example

Parameters

Response

​Request

​Date range example

​Single date example

​Parameters

​Response

Request

Date range example

Single date example

Parameters

Response