Scheduler

List scheduled payment-link emails

Lists active schedules by send time; completed/cancelled items are removed. Emails use workspace reply-to/format at send time. Cursor-paginated: pass limit (1–100) and send pagination.next_cursor back as cursor until has_more is false. To learn HOW MANY rows match without walking every page, pass include_total=true once and read pagination.total_count.

Available to admin and readonly API keys (no side effects).

get/v1/scheduled-emails

Request

  • Base URL: https://api.getfinero.com/functions/v1/api
  • URL: https://api.getfinero.com/functions/v1/api/v1/scheduled-emails
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size, 1–100. Default 25.

cursorstring

Opaque pagination cursor from a previous response's pagination.next_cursor.

order'asc' | 'desc'

Sort direction. THIS list is ordered by scheduled_for — when the email is due to send — not by creation time, because it is a send queue. Unlike every other list here, that value is MUTABLE: rescheduling through PATCH /v1/scheduled-emails/{scheduledEmailId} moves a row within the order. A row rescheduled across your cursor between pages can therefore be missed or returned twice. If you need an exact set, re-walk from the first page, or filter by status and reconcile on id. Default desc (latest send time first).

include_totalboolean

Return pagination.total_count — the number of rows matching the filters, ignoring paging. It is the SAME number on every page, including alongside a cursor. Off by default: an exact count scans the whole filtered set, so asking on each page pays repeatedly for an answer that does not change — ask on the first request and keep it.

status'scheduled' | 'processing' | 'failed'

Filter by scheduler state.

payment_link_idstring uuid

Filter by payment link.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.