Search ReportSubscriptions

GET

api

sys

reportsubscriptions

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the business the schedule belongs to.

string

Filter by name of the schedule, e.g. Weekly revenue to finance.

integer

Filter by saved report to send (exactly one of ReportDefinitionId, ReportDashboardId, TemplateKey or DashboardTemplateKey).

string

Filter by display value for ReportDefinition.Name..

integer

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

string

Filter by display value for ReportDashboard.Name..

string

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

string

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

string

Filter by email addresses separated by commas or semicolons.

string

Filter by optional email subject; defaults to the report or dashboard name.

integer

Filter by daily, Weekly or Monthly.

integer

Filter by weekly schedules: 1 = Monday … 7 = Sunday.

integer

Filter by monthly schedules: day of the month (1-28).

integer

Filter by hour of the day to send (0-23) in the business time zone.

boolean

Filter by attach the report data as CSV files.

boolean

Filter by include an AI-written summary of the results in the email body.

string

Filter by 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

Filter by paused schedules are kept but not sent.

integer

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

string

Filter by display value for Owner.FullName..

string

Filter by display value for Owner.Email..

string

Filter by uTC time of the next delivery (computed from the schedule).

string

Filter by uTC time of the last delivery attempt.

string

Filter by sent or Failed.

string

Filter by error message of the last failed delivery.

integer

Filter by number of deliveries attempted.

Range Filters

integer

Filter by weekly schedules: 1 = Monday … 7 = Sunday greater than or equal to this value.

integer

Filter by weekly schedules: 1 = Monday … 7 = Sunday less than or equal to this value.

integer

Filter by monthly schedules: day of the month (1-28) greater than or equal to this value.

integer

Filter by monthly schedules: day of the month (1-28) less than or equal to this value.

integer

Filter by hour of the day to send (0-23) in the business time zone greater than or equal to this value.

integer

Filter by hour of the day to send (0-23) in the business time zone less than or equal to this value.

string

Filter by uTC time of the next delivery (computed from the schedule) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time of the next delivery (computed from the schedule) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time of the last delivery attempt greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time of the last delivery attempt less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by number of deliveries attempted greater than or equal to this value.

integer

Filter by number of deliveries attempted less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportsubscriptions?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportsubscriptions?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportsubscriptions',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportsubscriptions?ReportSubscription_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportsubscriptions?' + new URLSearchParams({
    ReportSubscription_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportsubscriptions',
    params={
        'ReportSubscription_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportsubscriptions?from_ReportSubscription_UpdatedOn=2025-01-01T00:00&to_ReportSubscription_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportsubscriptions?' + new URLSearchParams({
    from_ReportSubscription_UpdatedOn: '2025-01-01T00:00',
    to_ReportSubscription_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportsubscriptions',
    params={
        'from_ReportSubscription_UpdatedOn': '2025-01-01T00:00',
        'to_ReportSubscription_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ReportSubscription[]

The list of ReportSubscription records matching the query. See the Get one ReportSubscription endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each ReportSubscription. The following fields are not populated in the Records[] response: ParametersJson.To get all fields, fetch the full record using the Get one ReportSubscription endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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,
      "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": "[email protected]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "ReportSubscription Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search ReportSubscriptions

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200