Search ReportDefinitions

GET

api

sys

reportdefinitions

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

import requests

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

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/reportdefinitions', 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 saved self-service report: a ReportQuery JSON document plus a visualization. Use report_catalog to discover fields, report_query to test a query before saving it, and report_run to execute a saved report.

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 ReportDefinition-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 that owns this report.

string

Filter by report name shown in the library.

string

Filter by optional description of what the report shows.

string

Filter by folder used to group reports in the library (e.g. Bookings, Billing).

string

Filter by root entity of the query; derived from QueryJson on save.

string

Filter by visualization type (table, number, bar, line, area, pie); derived from VisualizationJson on save.

string

Filter by reportQuery JSON document (version 1). Use report_catalog to discover entities and field paths and report_query to test the query before saving..

string

Filter by visualizationDocument JSON: { “type”: “table|number|bar|line|area|pie”, “settings”: { … } }.

integer

Filter by version of the QueryJson schema.

boolean

Filter by visible to every user of the business; when false only the owner sees it.

integer

Filter by user who created the report (set automatically).

string

Filter by display value for Owner.FullName..

string

Filter by display value for Owner.Email..

string

Filter by key of the built-in template this report was copied from, if any.

string

Filter by uTC time the report was last run.

integer

Filter by number of times the report has been run.

Range Filters

integer

Filter by version of the QueryJson schema greater than or equal to this value.

integer

Filter by version of the QueryJson schema less than or equal to this value.

string

Filter by uTC time the report was last run greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC time the report was last run less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by number of times the report has been run greater than or equal to this value.

integer

Filter by number of times the report has been run 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/reportdefinitions?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdefinitions?' + 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/reportdefinitions',
    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/reportdefinitions?ReportDefinition_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdefinitions?' + new URLSearchParams({
    ReportDefinition_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/reportdefinitions',
    params={
        'ReportDefinition_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/reportdefinitions?from_ReportDefinition_UpdatedOn=2025-01-01T00:00&to_ReportDefinition_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdefinitions?' + new URLSearchParams({
    from_ReportDefinition_UpdatedOn: '2025-01-01T00:00',
    to_ReportDefinition_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/reportdefinitions',
    params={
        'from_ReportDefinition_UpdatedOn': '2025-01-01T00:00',
        'to_ReportDefinition_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ReportDefinition[]

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

Partial records — The listing endpoint returns a summary representation of each ReportDefinition. The following fields are not populated in the Records[] response: QueryJson, VisualizationJson.To get all fields, fetch the full record using the Get one ReportDefinition 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": "",
      "Description": null,
      "Folder": null,
      "EntityName": null,
      "VisualizationType": null,
      "SchemaVersion": 0,
      "IsShared": false,
      "OwnerId": null,
      "OwnerFullName": null,
      "OwnerEmail": null,
      "TemplateKey": null,
      "LastRunOn": 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": "ReportDefinition 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 ReportDefinitions

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

import requests

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

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/reportdefinitions', 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