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

# Get roster

> Gets the account's roster.

## Overview

Gets the account's roster.

## HTTP request

`POST /Agent/Xmpp/GetRoster`

## Authentication

Requires a valid JWT bearer token.

## Request (JSON)

```json theme={null}
{
	"offset":Optional(Int(0 <= POffset <= 2147483647)),
	"maxCount":Optional(Int(0 < PMaxCount <= 2147483647))
}
```

## Input parameters

| Parameter | Description                                   |
| --------- | --------------------------------------------- |
| POffset   | Offset into the roster where response begins. |
| PMaxCount | Maximum number of roster items to return.     |

## Response (JSON)

```json theme={null}
{
	"RosterItems":
	{
		"bareJid": Required(Str(PBareJid)),
		"pendingSubscription": Required(Bool(PPendingSubscription)),
		"status": Required(Str(PStatus)),
		"name": Required(Str(PName)),
		"Groups": Optional(Str(PGroups)[])
	}?[]
}
```

## Response parameters

| Parameter            | Description                                                             |
| -------------------- | ----------------------------------------------------------------------- |
| PBareJid             | Bare JID of roster item.                                                |
| PPendingSubscription | If the account has a pending subscription request to the remote entity. |
| PStatus              | Status of roster item.                                                  |
| PName                | Name given to the roster item.                                          |
| PGroups              | Names of groups to which the roster item is assigned.                   |

## Notes

This endpoint uses the request schema notation described in [Pattern matching](/guides/pattern-matching).