---
title: "List owned export schedules"
method: GET
path: "/v1/exports/schedules"
tags: ["Exports"]
---

# List owned export schedules

`GET /v1/exports/schedules`

## Request

- Base URL: `https://api.kawaa.com`
- URL: `https://api.kawaa.com/v1/exports/schedules`
- Auth: one of:
  - API key in header `X-Api-Key`
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.kawaa.com/oauth/authorize`, token URL `https://api.kawaa.com/oauth/token`, scopes: `exports:read`)

Returns retained schedules for the authenticated account. scheduling_available and manual_run_available state whether this account can create, change and run schedules, and request a run now; an account without access can still read and remove retained schedules. Scheduled exports deliver by email, webhook or Amazon S3. Google Cloud Storage and Azure Blob Storage delivery is not available yet: a schedule that would deliver to one cannot be created, changed, resumed or run, and a run that reaches one fails without sending anything. run_in_progress means the schedule has an unfinished export request. Private credentials and run identities are omitted.

## Response `200`

Owned schedules and current account availability.

- object
  - `success` boolean, required
  - `data` object, required
    - `scheduling_available` boolean, required
    - `manual_run_available` boolean, required
    - `schedules` object[], required
      - `id` string, required
      - `name` string
      - `enabled` boolean, required
      - `on_hold` boolean, required
      - `run_in_progress` boolean, required
      - `next_run_at` string, nullable
      - `last_run_status` string, nullable
      - `delivery_destination_unsubscribed_at` string, date-time, nullable: When the email recipient, an address other than the account's own verified email, used the unsubscribe link in an export email. No schedule of the account emails it after that. Null while it still receives them, and for webhook and cloud storage schedules.

## Other responses

- `401`: No credential, or one that is not accepted. `code` distinguishes `API_KEY_SUSPENDED` (subscription ended; restartable) from `API_KEY_REVOKED`, `SESSION_EXPIRED` and `OAUTH_TOKEN_EXPIRED` (a connected app's one-hour access token lapsed: refresh it and retry, or sign in again if no refresh token was issued or the refresh is refused).
- `403`: Refused, and **the code says which of three problems it is**, and they need different remedies: - `INSUFFICIENT_SCOPE`: the credential is valid but not scoped for this route. With an API key, issue one that carries the scope named in the message. With an OAuth access token, connect the app again asking for that scope as well as the ones it has, unless the message says a connected app can never be given it; then use an API key with every scope the message names, or have the account owner do it in the dashboard. - `PLAN_UPGRADE_REQUIRED`: the account's plan does not include the feature. **No key of any scope reaches it**, so issuing another is wasted work; the remedy is a plan change. Returned by the verification routes for `options.enrich`, and by the finder, the monitors, the audit log, auto-clean and the white-label routes. - `PLAN_LIMIT_EXCEEDED`: the plan includes the feature and the account is at its ceiling (webhook endpoints, team seats, integrations, auto-clean lists). Delete one or upgrade. - `FORBIDDEN`: refused for a reason none of the above covers. `ErrorCode` is an open set, so branch on the code with a default rather than exhaustively.
- `429`: Too many requests. When the server knows how long to wait, `Retry-After` says so and `error.retry_after_seconds` carries the same number; the `X-RateLimit-*` headers say where you stand.
- `default`: Any status this operation does not list. Kawaa's own errors carry the error envelope. The gateway in front of the API can answer any operation with its own bare body (`GatewayError`): a `503` after about 29 seconds, when the request may still have run and been charged, a `413` for a body over about 6 MB, or a `400` for a path with malformed percent-encoding.

---

[API](https://skmtc.dev/kawaa/apis/kawaa-api.md) · [All operations](https://skmtc.dev/kawaa/apis/kawaa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kawaa/apis/kawaa-api/revisions/d27c9c33f6ba?raw)