Skip to main content
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>'
{
  "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

​
id
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"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
Name
string
The name value for this report.
​
Folder
string
The folder value for this report.
​
ReportType
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.
​
ReportXml
string
The report xml value for this report.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}