---
title: "system.roster.getRoster"
description: "Returns the roster corresponding to the given name."
---

# system.roster.getRoster

> Returns the roster corresponding to the given name.

This function is used in **Python Scripting**.

## Description
Returns the roster corresponding to the given name. You can call getUsers() to access a list of User objects in the RosterModel.

 Call getDescription() to access the Description field of the specified roster.   

## Syntax
`system.roster.getRoster(rosterName)`

### Parameters
Type | Parameter | Description 
------- | ------- | ------
String | `name` | The name of the roster to get the RosterModel object from.

### Returns
**RosterModel** - The RosterModel object of the given roster name. 
### Scope
Gateway, Perspective Session

## Code Examples

```python title="Code Snippet"
# This example gets the RosterModel object from a roster called "some roster" when a Button is pressed and prints the object to the browser console.
 
roster = system.roster.getRoster("some roster")
system.perspective.print(roster)
```