Get one Report

GET

api

sys

reports

{id}

Get one Report

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

import requests

url = "https://spaces.nexudus.com/api/sys/reports/{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/reports/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Folder": "<string>",
  "ReportType": 123,
  "ReportXml": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A Report defines a configured report that can be generated on demand or scheduled. Reports cover various data categories including check-ins, invoices, bookings, members, revenue, and occupancy metrics.

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 Report-Read role.

Path Parameters

integer

required

The Id of the Report record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

The name value for this report.

string

The folder value for this report.

integer

The report type value for this report. See eReportType enum values: 1 = Checkins, 2 = ExtraServices, 3 = TimePasses, 4 = Members, 5 = AllMembers, 6 = Invoices, 7 = Bookings, 8 = TodayBookings, 9 = PaidInvoices, 10 = Upgrades, 11 = Tariffs, 12 = Accruals, 13 = Transactions, 14 = AccrualsLiable, 15 = AccrualsDelivered, 16 = IncomePaid, 17 = AccountsReceivable, 18 = TariffHistory, 19 = RecurrentCharges, 20 = Events, 21 = BookingCredit, 22 = AccrualsByDelivery, 23 = Tasks, 24 = AllTasks, 25 = Visitors, 26 = CrmLeadTimes, 27 = Desks, 28 = UpgradesTransactions, 29 = DesksOccupancy, 30 = PricePlanOccupancy, 31 = UnPaidInvoices, 32 = ResourceOccupancy, 33 = Crm, 34 = SimpleBookings, 35 = Surveys, 36 = AccrualsBySaleDate, 37 = InvoiceHeaders, 38 = InvoicesBySaleDate, 39 = DeferredRevenueByMonth, 40 = Discounts, 41 = CustomerCountChurnByMonth, 42 = CustomerDetailsChurnByMonth, 43 = CustomerCountChurnByMonthPayingMembers, 44 = CustomerDetailsChurnByMonthPayingMembers, 45 = FormPages, 46 = GetCustomerDetailsRevenueChurnByMonth, 47 = CancelledBookings, 998 = CustomUrl, 999 = CustomProcedure.

string

The report xml value for this report.

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": "",
  "Folder": "",
  "ReportType": 0,
  "ReportXml": null,
  "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": "Report Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple ReportsRetrieve multiple Report records by their Ids in a single request.

Get one Report

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

import requests

url = "https://spaces.nexudus.com/api/sys/reports/{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/reports/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Folder": "<string>",
  "ReportType": 123,
  "ReportXml": "<string>",
  "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