Get Broadcast | SchoolSet

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

{
  "status": "success",
  "message": "Broadcast retrieved successfully.",
  "data": {
    "id": 1562,
    "academic_year": {
      "id": 2024,
      "title": "2023-2024 Academic Year"
    },
    "type": {
      "id": 3,
      "title": "General Announcement",
      "sys_name": "general_announcement"
    },
    "method": {
      "id": 2,
      "sys_name": "email"
    },
    "status": {
      "id": 1,
      "title": "Sent",
      "sys_name": "sent"
    },
    "from": {
      "id": 101,
      "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": [
          4,
          5
        ]
      }
    ],
    "sent_date": "2024-06-10T09:30:00Z",
    "subject": "Upcoming School Holiday Notice",
    "message": "Dear parents, please be informed that the school will be closed on June 15th for a public holiday.",
    "voice": {},
    "attributes": {
      "message": {
        "priority": "high",
        "read_receipt": true
      },
      "document_template_recipients": [
        {
          "recipient_id": 501,
          "template_id": 12
        }
      ],
      "form": {
        "form_id": 7,
        "submitted": false
      }
    },
    "form": {
      "id": 7
    },
    "statuses": [
      {
        "recipient_id": 501,
        "status": "delivered",
        "timestamp": "2024-06-10T09:31:00Z"
      }
    ],
    "attachments": [
      {
        "id": 301,
        "file_hash": "a1b2c3d4e5f67890",
        "file_name": "holiday_notice.pdf",
        "file_original_name": "School_Holiday_Notice_June_2024.pdf",
        "file_mime_type": "application/pdf",
        "caption": "School Holiday Notice June 2024",
        "url": "https://app.schoolset.io/files/holiday_notice.pdf",
        "file_size": 24576,
        "created_by": "admin@schoolset.io",
        "created_at": "2024-06-01T08:00:00Z",
        "updated_at": "2024-06-01T08:00:00Z",
        "related_to": "broadcast",
        "model_name": "Broadcast",
        "model_id": 1562
      }
    ]
  }
}

Returns v1 broadcast information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/broadcast/{id}.

statusenum

Allowed values:

messagestring

dataobject