Get a notification schedule

Returns one queued or completed notification schedule.

GET

https://api.portal.magicdoor.com/company-app/notifications/schedules/{notificationScheduleId}

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.

notificationScheduleIdstringrequired

The schedule to fetch.

example: 1831310445621149696

idstring

The schedule.

sourceenum<string>

manual means someone set it up; system means MagicDoor created it itself, for example when onboarding finished.

systemmanual

targetobject

Who it will go to.

templateobject

What will be sent.

timestring · date-time

When it is due to go out.

statusenum<string>

pending means it has not run yet and can still be edited or deleted. skipped means MagicDoor decided not to send it.

pendingsentskippedfailed

sentstring · date-time

When it actually went out. Absent while pending.

failureReasonstring

Why it failed, when it did.

announcementIdstring

The announcement this schedule sends. Present on a schedule created by scheduling an announcement.

createdstring · date-time

When the schedule was set up.