Skip to main content

List workspace contests (v1)

Method & Path​

GET /api/v1/workspace/:workspaceId/contests

Description​

Lists contests for the workspace (draft, open, ended).

Authentication​

Required: Workspace owner or staff token with access to the workspace. Persona: Workspace Owner (Staff: section not exposed).

Headers​

  • Authorization: Bearer <workspace_access_token>

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace ID

Response 200 OK​

{
  "contests": [
    {
      "id": "...",
      "workspaceId": "...",
      "name": "مسابقة",
      "publicToken": "...",
      "status": "draft",
      "introQuestions": [],
      "questionsToShowCount": 10,
      "timeLimitSeconds": 300,
      "backgroundKind": "none",
      "backgroundColor": null,
      "backgroundImageUrl": null,
      "questionPoolSize": 5,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Common Errors​

  • 401 Unauthorized: Missing or invalid token
  • 403 Forbidden: No access to workspace