MagicDoorAPI
SupportOpen MagicDoor
Notifications

List notification schedules

Returns a page of the messages queued to go out in the future, along with those that have already run.

GET
https://api.portal.magicdoor.com/company-app/notifications/schedules

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Query parameters

pageinteger

Which page to return. The first page is 1.

default: 1example: 1
pageSizeinteger

How many items to return per page. Between 1 and 100.

default: 50example: 25
sourceenum<string>

Only return schedules of this origin.

systemmanual
statusenum<string>

Only return schedules in this state.

pendingsentskippedfailed
time.startstring · date-time

Only return schedules due on or after this moment.

time.endstring · date-time

Only return schedules due on or before this moment.

Response

200 · One page of schedules.

itemsNotificationSchedule[]

The schedules.

currentPageinteger

The page number that was returned.

totalPagesinteger

How many pages exist at this page size.

pageSizeinteger

How many items a page holds.

totalCountinteger

How many items match in total, across every page.

401 · The access token is missing, expired, or not valid.

A notification schedule is a message queued for a future date. When its time comes MagicDoor turns it into an announcement and sends it: textMessage is posted into each recipient's chat and sent as an SMS, and emailMessage is emailed to them under subject.

This is not the same thing as a chat notification setting. It is a one-off future send, not a preference.

Scheduling an announcement also lands here, with source set to manual and announcementId pointing at the announcement. Filter on status of pending to see what is still to go out.