Get Session - Series Documentation

Retrieve detailed information about a specific session, including its connected place ID, auto-ranking settings, role permissions, and recurrence parameters.

Request

curl -X GET https://api.series.hr/sessions/get/session_abc123 \
  -H "apikey: YOUR_API_KEY"

Parameters

string

required

The session ID to retrieve

Response

{
  "success": true,
  "data": {
    "SessionId": "session_1234567890_abc12345678",
    "WorkspaceId": "workspace_abc123",
    "Title": "Training Session",
    "Description": "Weekly staff training session",
    "Host": "714760171",
    "CoHost": "123456789",
    "Supervisor": "987654321",
    "PlaceId": "1234567890",
    "ServerId": null,
    "Scheduled": "2024-01-20T15:00:00.000Z",
    "Delayed": false,
    "Status": "upcoming",
    "Claimable": true,
    "AutoRankPassers": true,
    "Duration": 60,
    "MinHostRank": 50,
    "MinCoHostRank": 25,
    "MinSupervisorRank": 100,
    "Recurring": false,
    "RecurrenceId": null,
    "HostPermissions": {
      "ChangeSessionStatus": true,
      "PassOrFailAttendees": true,
      "ModifyAttendance": true
    },
    "CoHostPermissions": {
      "ChangeSessionStatus": false,
      "PassOrFailAttendees": true,
      "ModifyAttendance": false
    },
    "SupervisorPermissions": {
      "ChangeSessionStatus": false,
      "PassOrFailAttendees": false,
      "ModifyAttendance": false
    },
    "CustomRoles": {
      "Trainer": {
        "MinRank": 25,
        "Permissions": {
          "ChangeSessionStatus": false,
          "PassOrFailAttendees": true,
          "ModifyAttendance": true
        },
        "Slots": {
          "714760171": { "Attended": false },
          "VACANT_1": { "Attended": false }
        }
      }
    }
  }
}

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