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

# NSListEntity

> The list entity contains information about a specific list.

The list entity contains information about a specific list.

## Constructors

### NSListEntity()

```crmscript theme={null}
NSListEntity
```

Initializes a new instance of the NSListEntity class.

## Methods

## GetDeleted()

```crmscript theme={null}
Bool GetDeleted()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if the list item is marked as deleted.

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool deleted = thing.GetDeleted();
```

## GetId()

```crmscript theme={null}
Integer GetId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The identity of the list.

**Example:**

```crmscript theme={null}
NSListEntity thing;
Integer id = thing.GetId();
```

## GetInUseByUserDefinedFields()

```crmscript theme={null}
Bool GetInUseByUserDefinedFields()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if this in use by one or more udfields.

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool inUseByUserDefinedFields = thing.GetInUseByUserDefinedFields();
```

## GetIsCustomList()

```crmscript theme={null}
Bool GetIsCustomList()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Indicates if this is a custom list or a standard list.

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool isCustomList = thing.GetIsCustomList();
```

## GetIsMDOList()

```crmscript theme={null}
Bool GetIsMDOList()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Indicates if this is an MDO list.

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool isMDOList = thing.GetIsMDOList();
```

## GetListType()

```crmscript theme={null}
String GetListType()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The type of this list, often indicated by the database name, but not necessarily.

**Example:**

```crmscript theme={null}
NSListEntity thing;
String listType = thing.GetListType();
```

## GetName()

```crmscript theme={null}
String GetName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the list.

**Example:**

```crmscript theme={null}
NSListEntity thing;
String name = thing.GetName();
```

## GetRank()

```crmscript theme={null}
Integer GetRank()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The rank of the list.

**Example:**

```crmscript theme={null}
NSListEntity thing;
Integer rank = thing.GetRank();
```

## GetTooltip()

```crmscript theme={null}
String GetTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The tooltip of the list.

**Example:**

```crmscript theme={null}
NSListEntity thing;
String tooltip = thing.GetTooltip();
```

## GetUseGroupsAndHeadings()

```crmscript theme={null}
Bool GetUseGroupsAndHeadings()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Indicates if this list should use groups and headings.

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool useGroupsAndHeadings = thing.GetUseGroupsAndHeadings();
```

## SetDeleted(Bool)

```crmscript theme={null}
Void SetDeleted(Bool deleted)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetId(Integer)

```crmscript theme={null}
Void SetId(Integer id)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
Integer id;
thing.SetId(id);
```

## SetInUseByUserDefinedFields(Bool)

```crmscript theme={null}
Void SetInUseByUserDefinedFields(Bool inUseByUserDefinedFields)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool inUseByUserDefinedFields;
thing.SetInUseByUserDefinedFields(inUseByUserDefinedFields);
```

## SetIsCustomList(Bool)

```crmscript theme={null}
Void SetIsCustomList(Bool isCustomList)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool isCustomList;
thing.SetIsCustomList(isCustomList);
```

## SetIsMDOList(Bool)

```crmscript theme={null}
Void SetIsMDOList(Bool isMDOList)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool isMDOList;
thing.SetIsMDOList(isMDOList);
```

## SetListType(String)

```crmscript theme={null}
Void SetListType(String listType)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
String listType;
thing.SetListType(listType);
```

## SetName(String)

```crmscript theme={null}
Void SetName(String name)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
String name;
thing.SetName(name);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
Integer rank;
thing.SetRank(rank);
```

## SetTooltip(String)

```crmscript theme={null}
Void SetTooltip(String tooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
String tooltip;
thing.SetTooltip(tooltip);
```

## SetUseGroupsAndHeadings(Bool)

```crmscript theme={null}
Void SetUseGroupsAndHeadings(Bool useGroupsAndHeadings)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSListEntity thing;
Bool useGroupsAndHeadings;
thing.SetUseGroupsAndHeadings(useGroupsAndHeadings);
```


## Related topics

- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [Delete List Entity](/en/api/reference/restful/agent/list_agent/delete-list-entity.md)
- [Default List Entity](/en/api/reference/restful/rest/list_/default-list-entity.md)
- [Get List Entity](/en/api/reference/restful/rest/list_/get-list-entity.md)
- [Post List Entity](/en/api/reference/restful/rest/list_/post-list-entity.md)