> ## 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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the ReportSubscription record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business the schedule belongs to.
</ResponseField>

<ResponseField name="Name" type="string">
  Name of the schedule, e.g. Weekly revenue to finance.
</ResponseField>

<ResponseField name="ReportDefinitionId" type="integer">
  Saved report to send (exactly one of ReportDefinitionId, ReportDashboardId, TemplateKey or DashboardTemplateKey).
</ResponseField>

<ResponseField name="ReportDefinitionName" type="string">
  Display value for ReportDefinition.Name..
</ResponseField>

<ResponseField name="ReportDashboardId" type="integer">
  Saved dashboard to send: every report tile is attached as CSV (set either ReportDefinitionId or ReportDashboardId).
</ResponseField>

<ResponseField name="ReportDashboardName" type="string">
  Display value for ReportDashboard.Name..
</ResponseField>

<ResponseField name="TemplateKey" type="string">
  Built-in report template to send (key from report\_templates), instead of a saved report.
</ResponseField>

<ResponseField name="DashboardTemplateKey" type="string">
  Built-in dashboard template to send (key from report\_templates kind=dashboard), instead of a saved dashboard.
</ResponseField>

<ResponseField name="Recipients" type="string">
  Email addresses separated by commas or semicolons.
</ResponseField>

<ResponseField name="Subject" type="string">
  Optional email subject; defaults to the report or dashboard name.
</ResponseField>

<ResponseField name="Frequency" type="integer">
  Daily, Weekly or Monthly.
</ResponseField>

<ResponseField name="DayOfWeek" type="integer">
  Weekly schedules: 1 = Monday ... 7 = Sunday.
</ResponseField>

<ResponseField name="DayOfMonth" type="integer">
  Monthly schedules: day of the month (1-28).
</ResponseField>

<ResponseField name="HourOfDay" type="integer">
  Hour of the day to send (0-23) in the business time zone.
</ResponseField>

<ResponseField name="IncludeAttachment" type="boolean">
  Attach the report data as CSV files.
</ResponseField>

<ResponseField name="IncludeSummary" type="boolean">
  Include an AI-written summary of the results in the email body.
</ResponseField>

<ResponseField name="ParametersJson" type="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.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Paused schedules are kept but not sent.
</ResponseField>

<ResponseField name="OwnerId" type="integer">
  User who created the schedule; reports run with this user's permissions (set automatically).
</ResponseField>

<ResponseField name="OwnerFullName" type="string">
  Display value for Owner.FullName..
</ResponseField>

<ResponseField name="OwnerEmail" type="string">
  Display value for Owner.Email..
</ResponseField>

<ResponseField name="NextRunOn" type="string">
  UTC time of the next delivery (computed from the schedule).
</ResponseField>

<ResponseField name="LastRunOn" type="string">
  UTC time of the last delivery attempt.
</ResponseField>

<ResponseField name="LastRunStatus" type="string">
  Sent or Failed.
</ResponseField>

<ResponseField name="LastError" type="string">
  Error message of the last failed delivery.
</ResponseField>

<ResponseField name="RunCount" type="integer">
  Number of deliveries attempted.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```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
}
```