Get one ReportSubscription

GET

api

sys

reportsubscriptions

{id}

Get one ReportSubscription

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/reportsubscriptions/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/reportsubscriptions/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/reportsubscriptions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "ReportDefinitionId": 123,
  "ReportDefinitionName": "<string>",
  "ReportDashboardId": 123,
  "ReportDashboardName": "<string>",
  "TemplateKey": "<string>",
  "DashboardTemplateKey": "<string>",
  "Recipients": "<string>",
  "Subject": "<string>",
  "Frequency": 123,
  "DayOfWeek": 123,
  "DayOfMonth": 123,
  "HourOfDay": 123,
  "IncludeAttachment": true,
  "IncludeSummary": true,
  "ParametersJson": "<string>",
  "Active": true,
  "OwnerId": 123,
  "OwnerFullName": "<string>",
  "OwnerEmail": "<string>",
  "NextRunOn": "<string>",
  "LastRunOn": "<string>",
  "LastRunStatus": "<string>",
  "LastError": "<string>",
  "RunCount": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

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

integer

required

The Id of the ReportSubscription record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportsubscriptions/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business the schedule belongs to.

string

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

integer

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

string

Display value for ReportDefinition.Name..

integer

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

string

Display value for ReportDashboard.Name..

string

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

string

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

string

Email addresses separated by commas or semicolons.

string

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

integer

Daily, Weekly or Monthly.

integer

Weekly schedules: 1 = Monday … 7 = Sunday.

integer

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

integer

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

boolean

Attach the report data as CSV files.

boolean

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

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.

boolean

Paused schedules are kept but not sent.

integer

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

string

Display value for Owner.FullName..

string

Display value for Owner.Email..

string

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

string

UTC time of the last delivery attempt.

string

Sent or Failed.

string

Error message of the last failed delivery.

integer

Number of deliveries attempted.

integer

Unique record identifier.

string

UUID of the record.

string

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

string

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

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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
}

Get one ReportSubscription

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/reportsubscriptions/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/reportsubscriptions/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/reportsubscriptions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "ReportDefinitionId": 123,
  "ReportDefinitionName": "<string>",
  "ReportDashboardId": 123,
  "ReportDashboardName": "<string>",
  "TemplateKey": "<string>",
  "DashboardTemplateKey": "<string>",
  "Recipients": "<string>",
  "Subject": "<string>",
  "Frequency": 123,
  "DayOfWeek": 123,
  "DayOfMonth": 123,
  "HourOfDay": 123,
  "IncludeAttachment": true,
  "IncludeSummary": true,
  "ParametersJson": "<string>",
  "Active": true,
  "OwnerId": 123,
  "OwnerFullName": "<string>",
  "OwnerEmail": "<string>",
  "NextRunOn": "<string>",
  "LastRunOn": "<string>",
  "LastRunStatus": "<string>",
  "LastError": "<string>",
  "RunCount": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200