RankGun logoRankGun
API ReferenceSessions

List Sessions

Paginated list of sessions with optional status and date filters.

GET /api/sessions

Returns a paginated list of sessions for the workspace. Results are ordered by scheduledStartAt descending (most recent first).

Headers

Prop

Type

Query Parameters

Prop

Type

curl "https://api.rankgun.works/api/sessions?status=scheduled&limit=50" \
  -H "x-api-key: YOUR_API_KEY"

Response

200 OK

{
  "success": true,
  "sessions": [
    {
      "id": "k7...",
      "title": "Saturday Training",
      "sessionTypeId": "j5...",
      "sessionTypeName": "Training",
      "status": "scheduled",
      "scheduledStartAt": 1712345678,
      "scheduledEndAt": 1712349278,
      "actualStartAt": null,
      "actualEndAt": null,
      "createdByRobloxId": 123456,
      "createdByUsername": "Builderman",
      "cancelledAt": null,
      "cancellationReason": null,
      "createdAt": 1712000000,
      "updatedAt": 1712000000
    }
  ],
  "nextCursor": "eyJpZCI6..."
}

All timestamp fields are seconds since epoch (Unix time). See the Timestamps section.

Pagination

  • If nextCursor is non-null, pass it back as the cursor query param to fetch the next page.
  • nextCursor is null when there are no more results.

Session Summary Fields

Prop

Type

Errors

StatusMeaning
400Invalid query parameters (bad status, negative limit, from > to).
401Missing API key.
403Invalid API key.
500Internal server error.
Was this page helpful?

List Session Types

List all active session types for the workspace.

Get Session

Get full details for a single session including participants.

On this page

Headers
Query Parameters
Response
Pagination
Session Summary Fields
Errors