# Get a report schedule — API reference

> Returns one report schedule with cadence, recipients, report type, next-run timestamps and frozen parameters.

Source: https://upfour.io/docs/api/reports/get-a-report-schedule

[Developers](https://upfour.io/docs/api.md)/[Reports](https://upfour.io/docs/api/reports.md)

Returns one report schedule with cadence, recipients, report type, next-run timestamps and frozen parameters.

GET https://app.upfour.io/v1/reports/schedules/{scheduleID}

scope report.read stable returns 200

## Parameters

| Field | Type | Description |
| --- | --- | --- |
| `scheduleID` required | uuid | path parameter |

## Returns

A successful request returns `200` with application/json.

Response fields 1 top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | ReportSchedule | |
| ReportSchedule · 21 fields FieldTypeDescription `cadence` string one of`weekly` `monthly` `created_at` string (date-time) `enabled` boolean `format` string one of`csv` `json` `pdf` `xlsx` `id` uuid `language` string  · nullable one of`en` `de` null when the schedule inherits. `name` string `next_run_at` string (date-time) `organization_id` uuid `params` object  · nullable free-form keys The frozen report parameters; see the request. `recipients` string[]  · nullable `report_type` string one of`executive_summary` `summary` `monitor_report` `monitors` `monitor_sla` `sla` `incident_analytics` `incidents` `response_time` `response-time` `downtime_ledger` `downtime-ledger` `trends` `send_hour` integer `timezone` string `updated_at` string (date-time) `client_id` uuid `created_by` uuid `day_of_month` integer `day_of_week` integer `effective_language` string one of`en` `de` The language the schedule renders in now. `last_run_at` string (date-time) | | |

## Errors

Only the errors this operation can return. Every error uses the [same envelope](https://upfour.io/docs/api/responses.md).

| Status | Code | Meaning |
| --- | --- | --- |
| 400 | [bad_request](https://upfour.io/docs/api/errors#code-bad_request) | The request is malformed or fails validation. |
| 404 | [not_found](https://upfour.io/docs/api/errors#code-not_found) | The requested resource does not exist or is outside the caller's scope. |
| 403 | [permission_denied](https://upfour.io/docs/api/errors#code-permission_denied) | The credentials do not permit this action. |

Every call can also return `unauthorized` (401), `rate_limit_exceeded` (429) or `internal_error` (500 / 502). See [Responses and errors](https://upfour.io/docs/api/responses.md).

[PreviousPreview a report schedule](https://upfour.io/docs/api/reports/preview-a-report-schedule.md) [NextUpdate a report schedule](https://upfour.io/docs/api/reports/update-a-report-schedule.md)

## Request

### cURL

```bash
curl -s "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $UP4_API_KEY"
```

### JavaScript

```javascript
const res = await fetch("https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001", {
  headers: {
    Authorization: `Bearer ${process.env.UP4_API_KEY}`,
  },
});
console.log(res.status, await res.json());
```

### Python

```python
import os
import requests

res = requests.get(
    "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001",
    headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"},
)
print(res.status_code, res.json())
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}
```

### PHP

```php
<?php
$ch = curl_init("https://app.upfour.io/v1/reports/schedules/00000000-0000-4000-8000-000000000001");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("UP4_API_KEY"),
    ],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n";
curl_close($ch);
```

## Response

### 200

```json
{
  "data": {
    "cadence": "weekly",
    "created_at": "2026-10-27T09:00:00Z",
    "created_by": "00000000-0000-4000-8000-000000000002",
    "day_of_week": 1,
    "effective_language": "en",
    "enabled": true,
    "format": "pdf",
    "id": "00000000-0000-4000-8000-000000000001",
    "language": "en",
    "name": "Weekly summary",
    "next_run_at": "2026-11-01T23:55:00Z",
    "organization_id": "00000000-0000-4000-8000-000000000003",
    "params": {
      "preset": "7d"
    },
    "recipients": [
      "anna@example.com"
    ],
    "report_type": "summary",
    "send_hour": 8,
    "timezone": "Europe/Berlin",
    "updated_at": "2026-10-27T09:00:00Z"
  }
}
```

### 400

```json
{
  "error": {
    "code": "bad_request",
    "message": "The request is malformed or fails validation.",
    "request_id": "req_…"
  }
}
```

### 403

```json
{
  "error": {
    "code": "permission_denied",
    "message": "The credentials do not permit this action.",
    "request_id": "req_…"
  }
}
```

### 404

```json
{
  "error": {
    "code": "not_found",
    "message": "The requested resource does not exist or is outside the caller's scope.",
    "request_id": "req_…"
  }
}
```