> ## 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 ReportDefinition

> Retrieve a single ReportDefinition record by its Id.

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

> [!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 **`ReportDefinition-Read`** role.

## Path Parameters

**id** `integer` *required*

The Id of the ReportDefinition record to retrieve.

## Code Examples

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

```javascript JavaScript theme={null}
const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdefinitions/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/reportdefinitions/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()
```

## Response

### 200

**BusinessId** `integer`

ID of the business that owns this report.

**Name** `string`

Report name shown in the library.

**Description** `string`

Optional description of what the report shows.

**Folder** `string`

Folder used to group reports in the library (e.g. Bookings, Billing).

**EntityName** `string`

Root entity of the query; derived from QueryJson on save.

**VisualizationType** `string`

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

**QueryJson** `string`

ReportQuery JSON document (version 1). Use report\_catalog to discover entities and field paths and report\_query to test the query before saving..

**VisualizationJson** `string`

VisualizationDocument JSON: \{ "type": "table|number|bar|line|area|pie", "settings": \{ ... } }.

**SchemaVersion** `integer`

Version of the QueryJson schema.

**IsShared** `boolean`

Visible to every user of the business; when false only the owner sees it.

**OwnerId** `integer`

User who created the report (set automatically).

**OwnerFullName** `string`

Display value for Owner.FullName..

**OwnerEmail** `string`

Display value for Owner.Email..

**TemplateKey** `string`

Key of the built-in template this report was copied from, if any.

**LastRunOn** `string`

UTC time the report was last run.

**RunCount** `integer`

Number of times the report has been run.

**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.

```json Example Response theme={null}
{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "Folder": null,
  "EntityName": null,
  "VisualizationType": null,
  "QueryJson": "",
  "VisualizationJson": 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": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ReportDefinition Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.