---
title: "List scheduled payment-link emails"
method: GET
path: "/v1/scheduled-emails"
tags: ["Scheduler"]
---

# List scheduled payment-link emails

`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

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).

## Query parameters

- `limit` integer
- `cursor` string
- `order` 'asc' | 'desc'
- `include_total` boolean
- `status` 'scheduled' | 'processing' | 'failed'
- `payment_link_id` string, uuid

## Response `200`

Success

- object
  - `data` object[], required: Active scheduled emails.
    - `id` string, uuid, required: Scheduled email id.
    - `payment_link_id` string, uuid, required: Payment link this email will deliver.
    - `scheduled_for` string, date-time, required: Resolved send instant (ISO 8601 UTC).
    - `timezone` string, required: Tenant timezone snapshot used for scheduling.
    - `status` 'scheduled' | 'processing' | 'failed', required: Current scheduler state. Successful deliveries leave this active queue.
    - `attempt_count` integer, required: Dispatch attempts so far.
    - `next_attempt_at` string, date-time, nullable, required: Next bounded retry instant (ISO 8601 UTC).
    - `last_error_code` string, nullable, required: Categorical failure code; never a provider response or recipient detail.
    - `created_at` string, date-time, required: Creation time (ISO 8601 UTC).
    - `updated_at` string, date-time, required: Last update time (ISO 8601 UTC).
  - `pagination` object, required
    - `next_cursor` string, nullable, required: Opaque cursor for the next page — pass as ?cursor=. Null when there are no further results.
    - `has_more` boolean, required: Whether another page exists.
    - `limit` integer, required: The page size that was applied.
    - `total_count` integer: Total rows matching the filters, ignoring paging. Present ONLY when the request passed ?include_total=true.

## Other responses

- `400`: `invalid_cursor` — The cursor is malformed, was issued for a different query, or (aging) the report changed. Restart without cursor, keeping the filters identical. `validation_failed` — The request failed schema validation. See error.details for field messages.
- `401`: `invalid_credentials` — The credential is malformed or does not match an active key. The response never reveals whether a key identifier exists. `missing_credentials` — No Authorization: Bearer header was sent. `revoked_credentials` — The presented key was revoked. Create a new key in Settings → API.
- `403`: `feature_unavailable` — The tenant's tier does not currently include API access. Feature rollout flags cannot grant this entitlement. `permission_denied` — The key's permission does not allow this operation (readonly keys cannot call admin-only operations).
- `404`: `not_found` — No such resource in YOUR tenant. Ids belonging to another tenant are indistinguishable from missing ones.
- `429`: `rate_limit_exceeded` — Too many requests. Honor the Retry-After header (seconds) before retrying — waiting that long is enough. The RateLimit-* fields on every response say how much headroom is left before this happens; pace against them instead of retrying into a refusal.
- `500`: `internal_error` — Unexpected server error. Safe to retry with the same Idempotency-Key.

---

[API](https://skmtc.dev/getfinero/apis/finero-public-api.md) · [All operations](https://skmtc.dev/getfinero/apis/finero-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getfinero/apis/finero-public-api/revisions/3d456e222775?raw)