# List the group challenges an organization runs

- Endpoint: `GET /v1/{organizationId}/group-challenge`
- Production: `https://api.main-team.org/v1/{organizationId}/group-challenge`
- Sandbox: `https://apisnd.main-team.org/v1/{organizationId}/group-challenge`
- Operation: `listGroupChallenges` (Group challenges)
- Authentication: `Authorization: Bearer <token>`, a short-lived token you sign with your API key and secret
- Permission: `group-challenge/read:$org:$ID`

## Description

Lists the group challenges of this organization that are running or have closed, the one whose dates start latest first. A group challenge is a project students do in small groups: their teacher forms a group from their own students in the panel, and the group works through the challenge’s steps between `windowStart` and `windowEnd`, uploading its work for each step in the panel or the app.

`isOpen` says whether it takes work right now. Challenges the organizers have not published are not listed.

A page at a time: `limit` is 20 by default and at most 100.

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `organizationId` | path | yes | string | The organization’s `_id`: 24 hexadecimal digits, as `listOrganizations` (`GET /v1/organization`) lists it. |
| `page` | query | no | number | Page number. Defaults to 1. |
| `limit` | query | no | number | Items per page. Defaults to 20, max 100. |

## Response

`200` Success: `message` is "Group challenges fetched successfully.".

```json
{
  "success": true,
  "message": "Group challenges fetched successfully.",
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 57,
    "totalPages": 3
  },
  "data": [
    {
      "_id": "6650a1b2c3d4e5f6a7b8c9eb",
      "name": "STEM Maker Challenge",
      "status": "published",
      "isOpen": true,
      "windowStart": "2026-10-01T00:00:00.000Z",
      "windowEnd": "2026-12-21T23:59:59.999Z",
      "minStudents": 2,
      "maxStudents": 3,
      "isPaid": false,
      "gradeGroups": [
        {
          "_id": "6650a1b2c3d4e5f6a7b8c9ec",
          "label": "Group 7-8-9",
          "grades": [
            {
              "_id": "6650a1b2c3d4e5f6a7b8c9d4",
              "name": "10"
            }
          ]
        }
      ],
      "steps": [
        {
          "_id": "6650a1b2c3d4e5f6a7b8c9ee",
          "order": 1,
          "title": "Project proposal",
          "fileTypes": [
            "pdf",
            "docx"
          ],
          "maxFileBytes": 20971520,
          "maxFiles": 1
        }
      ]
    }
  ]
}
```

## Errors

| Status | Code | When |
| --- | --- | --- |
| 401 | [`unauthorized`](https://hub.main-team.org/api/errors#unauthorized) | The token is missing or malformed, is not signed with your account’s `apiSecret`, breaks the `iat` and `exp` rules, has expired or been revoked, or its account is not active. All of these answer the same. |
| 403 | [`forbidden`](https://hub.main-team.org/api/errors#forbidden) | The token is valid, but no role on your account allows `group-challenge/read` on the organization in the path, or a role denies it. |
| 404 | [`not_found`](https://hub.main-team.org/api/errors#not_found) | `organizationId` is not the `_id` of an organization. |
| 404 | [`not_found`](https://hub.main-team.org/api/errors#not_found) | Group challenges are not switched on for this organization. The answer is the one an unknown path gets; nothing was read. |
| 429 | [`too_many_requests`](https://hub.main-team.org/api/errors#too_many_requests) | Your account has made more than 100 requests to this operation in the current 60-second window. Wait the seconds in `Retry-After` before sending again. |
| 500 | [`internal_error`](https://hub.main-team.org/api/errors#internal_error) | Something failed on our side. Retry later, and quote `request_id` if it goes on. |

## Code samples

### curl

```bash
# $TOKEN: a short-lived token you minted with your API key and secret
curl -sS 'https://api.main-team.org/v1/<organizationId>/group-challenge?page=1&limit=20' \
  -H "Authorization: Bearer $TOKEN"
```

### Node.js

```js
const token = process.env.TOKEN; // a short-lived token you minted with your API key and secret

const res = await fetch('https://api.main-team.org/v1/<organizationId>/group-challenge?page=1&limit=20', {
  headers: {
    Authorization: `Bearer ${token}`,
  },
});
const body = await res.json();
if (!res.ok) throw new Error(`${res.status} ${body.error.code}: ${body.error.message}`);
console.log(body.data, body.pagination);
```

### PHP

```php
<?php
$token = getenv('TOKEN'); // a short-lived token you minted with your API key and secret

$ch = curl_init('https://api.main-team.org/v1/<organizationId>/group-challenge?page=1&limit=20');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$body = json_decode($response, true);
if ($status >= 400) {
    $error = $body['error'];
    throw new RuntimeException("$status {$error['code']}: {$error['message']}");
}
print_r($body['data']);
print_r($body['pagination']);
```