> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one Report

> Retrieve a single Report record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the Report record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/sys/reports/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

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

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="Name" type="string">
  The name value for this report.
</ResponseField>

<ResponseField name="Folder" type="string">
  The folder value for this report.
</ResponseField>

<ResponseField name="ReportType" type="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.
</ResponseField>

<ResponseField name="ReportXml" type="string">
  The report xml value for this report.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```