> For the complete documentation index, see [llms.txt](https://docs.clashperk.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clashperk.com/features/rosters/list-rosters-and-groups.md).

# List Rosters and Groups

<mark style="color:blue;">**/roster list**</mark> <mark style="color:purple;">**name:**</mark> `Name` <mark style="color:purple;">**user:**</mark> `User` <mark style="color:purple;">**player\_tag:**</mark> `Tag` <mark style="color:purple;">**clan:**</mark> `Clan`

### Getting all Rosters and Groups

Run the <mark style="color:blue;">**/roster list**</mark>

Shows Rosters with Index, Name, Clan and amount of Members/Max Members.

Shows Groups with Index, Name, (Public/Private) Status and \[Order X]

{% hint style="warning" %}
Groups are only shown when running the command without filter options.
{% endhint %}

### Options / Filter

Filter **Rosters** using any of the following Options:

* **name** - List any Roster with the set Name
* **user** - List any Roster where that user is in with an Account
* **player\_tag** - List all Rosters where that Account is in
* **clan** - List all Rosters from that specific Clan


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.clashperk.com/features/rosters/list-rosters-and-groups.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
