Get Broadcasts | SchoolSet

curl https://app.schoolset.io/app/api/v1/broadcasts/year_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Broadcasts retrieved successfully.",
  "data": [
    {
      "id": 1024,
      "academic_year": {
        "id": 2023,
        "title": "2023-2024 Academic Year"
      },
      "type": {
        "id": 3,
        "title": "Emergency Alert",
        "sys_name": "emergency_alert"
      },
      "method": {
        "id": 2,
        "sys_name": "email"
      },
      "status": {
        "id": 1,
        "title": "Sent",
        "sys_name": "sent"
      },
      "from": {
        "name": "School Administration",
        "email": "admin@schoolset.io"
      },
      "to": [
        {
          "id": 501,
          "type": "parent",
          "data": {
            "id": 501,
            "name": "Jane Doe",
            "email": "jane.doe@example.com",
            "cell_phone": "+15551234567"
          },
          "status": {
            "id": 1,
            "title": "Delivered",
            "sys_name": "delivered"
          },
          "grade_ids": [
            5,
            6
          ]
        }
      ],
      "sent_date": "2024-04-20T08:30:00Z",
      "subject": "Urgent: School Closure Tomorrow",
      "message": "Due to severe weather conditions, the school will be closed tomorrow, April 21st.",
      "voice": {},
      "attributes": {
        "message": {
          "priority": "high",
          "read_receipt": true
        },
        "document_template_recipients": [
          {
            "recipient_id": 501,
            "template_id": 12
          }
        ],
        "form": {
          "form_id": 45,
          "submitted": false
        }
      },
      "form": {
        "id": 45
      },
      "statuses": [
        {
          "recipient_id": 501,
          "status": "delivered",
          "timestamp": "2024-04-20T08:31:00Z"
        }
      ],
      "attachments": [
        {
          "id": 301,
          "file_hash": "a1b2c3d4e5f67890",
          "file_name": "weather_alert.pdf",
          "file_original_name": "Severe_Weather_Alert.pdf",
          "file_mime_type": "application/pdf",
          "caption": "Severe Weather Alert Document",
          "url": "https://app.schoolset.io/files/weather_alert.pdf",
          "file_size": 245760,
          "created_by": "admin@schoolset.io",
          "created_at": "2024-04-19T15:00:00Z",
          "updated_at": "2024-04-19T15:00:00Z",
          "related_to": "broadcast",
          "model_name": "Broadcast",
          "model_id": 1024
        }
      ]
    }
  ]
}

Returns v1 broadcasts information for the selected context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

year_idstringRequired

Response

Successful GET response for /api/v1/broadcasts/{year_id}.

statusenum

Allowed values:

messagestring

datalist of objects