> ## 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.

## Authentication

Requires a valid JWT bearer token.

## Notes

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


## OpenAPI

````yaml /test-api/openapi.yaml post /Agent/Xmpp/GetRoster
openapi: 3.1.0
info:
  title: Neuron Agent API
  version: 1.0.0
  description: |-
    The Agent API exposes core Neuron functionality over HTTP so services can
    operate without a persistent XMPP connection. Endpoints are grouped by
    capability, starting with Accounts and XMPP messaging.
servers:
  - url: https://{host}
    variables:
      host:
        default: neuron.example.com
        description: Neuron domain issued to you.
security:
  - bearerAuth: []
tags:
  - name: Accounts
  - name: Crypto
  - name: Open intelligence
  - name: Legal and contracts
  - name: State machines
  - name: Storage
  - name: Tokens
  - name: Wallet
  - name: XMPP messaging
paths:
  /Agent/Xmpp/GetRoster:
    post:
      tags:
        - XMPP messaging
      summary: Get Roster
      description: Gets the account's roster.
      operationId: post_Agent_Xmpp_GetRoster
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                offset:
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                maxCount:
                  type: integer
                  exclusiveMinimum: 0
                  maximum: 2147483647
              additionalProperties: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  RosterItems:
                    type: array
                    items:
                      type: object
                      properties:
                        bareJid:
                          type: string
                        pendingSubscription:
                          type: boolean
                        status:
                          type: string
                        name:
                          type: string
                        Groups:
                          type: array
                          items:
                            type: string
                      additionalProperties: true
                      required:
                        - bareJid
                        - pendingSubscription
                        - status
                        - name
                additionalProperties: true
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````