---
title: "Lusid.Scope"
slug: "lusidscope"
tags: ["luminesce ", "provider", "scope"]
updated: 2024-08-21T10:37:37Z
published: 2024-08-21T10:37:37Z
canonical: "support.lusid.com/lusidscope"
---

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

# Lusid.Scope

| **Type** | **Read/write** | **Author** | **Availability** |
| --- | --- | --- | --- |
| [Data provider](/v1/docs/what-are-a-data-provider-and-a-direct-provider) | Read | Finbourne | Provided with LUSID |

The `Lusid.Scope` provider enables you to write a [Luminesce SQL query](/v1/docs/understanding-the-luminesce-sql-query-syntax) that retrieves information about all your [scopes](/v1/docs/what-is-a-scope).

> **Note:** The LUSID user running the query must have sufficient [access control permissions](/v1/docs/creating-policies-to-control-access-to-providers-for-different-luminesce-end-users) to both use the provider *and* read scope data stored in LUSID. This should automatically be the case if you are the domain owner.

## Basic usage

```sql
select * from Lusid.Scope where <filter-expression>
```

## Query parameters

`Lusid.Scope` has parameters that enable you to filter or refine a query.

To list available parameters, their data types, default values, and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries):

```sql
select FieldName, DataType, ParamDefaultValue, Description from Sys.Field where TableName = 'Lusid.Scope' and FieldType = 'Parameter';
```

## Data fields

By default, `Lusid.Scope` returns a table of data populated with particular fields (columns). You can return a subset of these fields.

To list fields available to return, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries):

```sql
select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Lusid.Scope' and FieldType = 'Column';
```

> **Note:** Fields marked 'main' are returned by queries that start `select ^ from Lusid.Scope`.

## Examples

**Note:** For more example Luminesce SQL queries, visit our [Github repo](https://github.com/finbourne/luminesce-examples/tree/master/examples).

### Example 1: Retrieve the first ten scopes

```sql
select * from Lusid.Scope limit 10
```

### Example 2: Retrieve all scopes starting with the letter 'b'

Scopes starting both 'b' and 'B' are returned:

```sql
select * from Lusid.Scope where Scope like 'b%'
```