Skip to main content
GET
/
api
/
sys
/
reports
Search Reports
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/reports \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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-List role.

​
Enums

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

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 0 for ascending, 1 for descending.

​
Filters

​
Report_Business
integer
Filter by iD of the business linked to this record.
​
Report_Name
string
Filter by the name value for this report.
​
Report_Folder
string
Filter by the folder value for this report.
​
Report_ReportType
integer
Filter by the report type value for this report.
​
Report_ReportXml
string
Filter by the report xml value for this report.

​
Range Filters

​
from_Report_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_Report_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_Report_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_Report_UpdatedOn
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/reports?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

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

​
Range filters

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

​
Response

​
200

​
Records
Report[]
The list of Report records matching the query. See the Get one Report endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each Report. The following fields are not populated in the Records[] response: ReportXml.To get all fields, fetch the full record using the Get one Report 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.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (0 = ascending, 1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Folder": "",
      "ReportType": 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": "Report 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
}