> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one ReportSubscription

> Retrieve a single ReportSubscription record by its Id.

A scheduled email delivery of a saved report or dashboard: the data is attached as CSV, the body carries an AI summary and a link to open it in the dashboard. Use report\_definition\_list / report\_dashboard\_list to find the report or dashboard to schedule.

## Authentication

> [!NOTE]
>
> This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
> The authenticated user must be a full unrestricted administrator or have the **`ReportSubscription-Read`** role.

## Path Parameters

**id** `integer` *required*

The Id of the ReportSubscription record to retrieve.

## Code Examples

```bash cURL theme={null}
curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportsubscriptions/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

```javascript JavaScript theme={null}
const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportsubscriptions/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();
```

```python Python theme={null}
import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportsubscriptions/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()
```

## Response

### 200

**BusinessId** `integer`

ID of the business the schedule belongs to.

**Name** `string`

Name of the schedule, e.g. Weekly revenue to finance.

**ReportDefinitionId** `integer`

Saved report to send (exactly one of ReportDefinitionId, ReportDashboardId, TemplateKey or DashboardTemplateKey).

**ReportDefinitionName** `string`

Display value for ReportDefinition.Name..

**ReportDashboardId** `integer`

Saved dashboard to send: every report tile is attached as CSV (set either ReportDefinitionId or ReportDashboardId).

**ReportDashboardName** `string`

Display value for ReportDashboard.Name..

**TemplateKey** `string`

Built-in report template to send (key from report\_templates), instead of a saved report.

**DashboardTemplateKey** `string`

Built-in dashboard template to send (key from report\_templates kind=dashboard), instead of a saved dashboard.

**Recipients** `string`

Email addresses separated by commas or semicolons.

**Subject** `string`

Optional email subject; defaults to the report or dashboard name.

**Frequency** `integer`

Daily, Weekly or Monthly.

**DayOfWeek** `integer`

Weekly schedules: 1 = Monday ... 7 = Sunday.

**DayOfMonth** `integer`

Monthly schedules: day of the month (1-28).

**HourOfDay** `integer`

Hour of the day to send (0-23) in the business time zone.

**IncludeAttachment** `boolean`

Attach the report data as CSV files.

**IncludeSummary** `boolean`

Include an AI-written summary of the results in the email body.

**ParametersJson** `string`

Optional JSON: for reports an array of prompt filter overrides \[\{field, op, value}], for dashboards an object of parameter values keyed by parameter id.

**Active** `boolean`

Paused schedules are kept but not sent.

**OwnerId** `integer`

User who created the schedule; reports run with this user's permissions (set automatically).

**OwnerFullName** `string`

Display value for Owner.FullName..

**OwnerEmail** `string`

Display value for Owner.Email..

**NextRunOn** `string`

UTC time of the next delivery (computed from the schedule).

**LastRunOn** `string`

UTC time of the last delivery attempt.

**LastRunStatus** `string`

Sent or Failed.

**LastError** `string`

Error message of the last failed delivery.

**RunCount** `integer`

Number of deliveries attempted.

**Id** `integer`

Unique record identifier.

**UniqueId** `string`

UUID of the record.

**CreatedOn** `string`

Date and time the record was created (ISO 8601).

**UpdatedOn** `string`

Date and time the record was last updated (ISO 8601).

**UpdatedBy** `string`

Email of the user who last updated this record.

**IsNew** `boolean`

Whether the record was recently created.

**SystemId** `string`

External system identifier.

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "ReportDefinitionId": null,
  "ReportDefinitionName": null,
  "ReportDashboardId": null,
  "ReportDashboardName": null,
  "TemplateKey": null,
  "DashboardTemplateKey": null,
  "Recipients": "",
  "Subject": null,
  "Frequency": 0,
  "DayOfWeek": 0,
  "DayOfMonth": 0,
  "HourOfDay": 0,
  "IncludeAttachment": false,
  "IncludeSummary": false,
  "ParametersJson": null,
  "Active": false,
  "OwnerId": null,
  "OwnerFullName": null,
  "OwnerEmail": null,
  "NextRunOn": null,
  "LastRunOn": null,
  "LastRunStatus": null,
  "LastError": null,
  "RunCount": 0,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ReportSubscription Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.