Developer Center›Guides›Scheduling

    Automating Monthly Reporting

    Use the public `/api/v1/schedules` routes to manage per-bureau automated submission cadence with API-key auth.

    Public Routes

    • GET /api/v1/schedules lists schedules for the authenticated company.
    • POST /api/v1/schedules creates or upserts a schedule by bureau.
    • GET /api/v1/schedules/{id} returns one saved schedule.
    • PATCH /api/v1/schedules/{id} updates cadence, timing, bureau, or enabled state.
    • DELETE /api/v1/schedules/{id} removes a schedule.

    Supported Fields

    • bureau: equifax, experian, or transunion
    • frequency: monthly, weekly, or biweekly
    • day_of_month or day_of_week depending on frequency
    • time_utc and optional enabled

    Internal Operational Routes

    The repo also includes cron-style operational endpoints under /api/cron/* such as /api/cron/run-scheduled-submissions. Those are backend operational routes behind the public schedule configuration APIs.