List all broadcasts

GET

https://ssuccessv2.com/app/api/v1/broadcasts

GET

/app/api/v1/broadcasts

$ curl https://ssuccessv2.com/app/api/v1/broadcasts \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "0": {
6       "id": 1842,
7       "academic_year": {
8         "id": 2025,
9         "title": "2026–2027"
10       },
11       "type": {
12         "id": 1,
13         "title": "SMS",
14         "sys_name": "sms"
15       },
16       "method": {
17         "id": 1,
18         "sys_name": "sms"
19       },
20       "status": {
21         "id": 3,
22         "title": "Scheduled",
23         "sys_name": "scheduled"
24       },
25       "from": null,
26       "to": [
27         {
28           "id": 731,
29           "type": "student",
30           "data": {
31             "id": 731,
32             "name": "Maya Rodriguez",
33             "email": "maya.parent@example.com",
34             "cell_phone": "+15551234567"
35           },
36           "status": {
37             "id": 1,
38             "title": "Pending",
39             "sys_name": "pending"
40           },
41           "grade_ids": [
42             4
43           ]
44         }
45       ],
46       "sent_date": {},
47       "subject": "Early dismissal on Friday",
48       "message": "School dismisses at 1:00 PM on September 4.",
49       "voice": null,
50       "attributes": {
51         "message": [],
52         "document_template_recipients": [],
53         "form_recipients": []
54       },
55       "form": {
56         "id": null
57       },
58       "statuses": [],
59       "attachments": []
60     }
61   }
62 }

Returns every broadcast for the active school, including recipient delivery status, attachments, and academic-year information.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Response

Broadcast list.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error