> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# List PTA events for a batch

GET https://ssuccessv2.com/app/api/v1/pta/events/{batch_id}

Returns PTA events belonging to the requested batch, including academic year, schedule configuration, target grades/classes/staff, and lifecycle timestamps. The collection is not paginated.

Reference: https://docs.schoolset.io/api-reference/school-set-api/pta-events/list-pta-events-by-batch

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `batch_id` (integer, required) — Academic-year or PTA batch identifier used by the UI.

## Response

### 200

PTA event collection returned; no matching events are represented by data: [].

- `status` (string, required)
- `message` (string, required)
- `data` (list of ApiV1PtaEventsBatchIdGetResponsesContentApplicationJsonSchemaDataItems, required)

## Errors

### 401 Unauthorized Error

Unauthenticated.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

Missing view-pta-events permission.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 422 Unprocessable Entity Error

batch_id must be numeric.

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Types

### ApiV1PtaEventsBatchIdGetResponsesContentApplicationJsonSchemaDataItems

- `id` (integer, required)
- `academic_year` (map from string to any, required)
- `title` (string, required)
- `start_date` (datetime, required)
- `end_date` (datetime, required)
- `pta_gap_parent_count` (integer, required)
- `schedule_type` (map from string to any, required)
- `slot_duration` (map from string to any, required)
- `pta_slot_meeting_count` (integer, required)
- `grades` (list of map from string to any, required)
- `classes` (list of map from string to any, required)
- `staff_members` (list of map from string to any, required)
- `parent_type` (enum, required)
  - Allowed values: `mother`, `father`, `both`
- `pass_event` (boolean, required)
- `exclude_staff_children` (boolean, required)
- `created_by` (string, required, nullable)
- `created_at` (datetime, required, nullable)
- `updated_at` (datetime, required, nullable)

## Examples

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1842,
      "academic_year": {
        "id": 2026,
        "name": "2026-2027"
      },
      "title": "Fall parent conferences",
      "start_date": {},
      "end_date": {},
      "pta_gap_parent_count": 2,
      "schedule_type": {
        "id": 1,
        "title": "Consecutive"
      },
      "slot_duration": {
        "id": 2,
        "title": "15 minutes"
      },
      "pta_slot_meeting_count": 1,
      "grades": [],
      "classes": [],
      "staff_members": [],
      "parent_type": "both",
      "pass_event": false,
      "exclude_staff_children": false,
      "created_by": "Taylor Morgan",
      "created_at": {},
      "updated_at": {}
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/pta/events/2026"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/pta/events/2026';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v1/pta/events/2026"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/pta/events/2026")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ssuccessv2.com/app/api/v1/pta/events/2026")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ssuccessv2.com/app/api/v1/pta/events/2026', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/pta/events/2026");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/pta/events/2026")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```