# app.atmobb.forum.getMembers

> Published by [lexicons.atmobb.app](https://lexicon.garden/identity/did:plc:dqnwiguwsbb6uwrm7a2rsff2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getMembers)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getMembers/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getMembers/examples)

## Definitions

### `app.atmobb.forum.getMembers`

**Type**: `query`

Members of a forum ordered by arrival, with atmobb profiles and the stamps they wear.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `forum` | `string` (did) | Yes |  |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `members` | `array` | Yes | Each item is shaped like #memberView. |

### `app.atmobb.forum.getMembers#memberView`

**Type**: `object`

One member as getMembers returns them.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `lastActive` | `string` (datetime) | No |  |
| `posts` | `integer` | No | Deprecated and no longer rendered: post count on this forum. Kept for older clients. |
| `profile` | `unknown` | No | The member's app.atmobb.actor.profile record, when they have one. |
| `since` | `string` (datetime) | No | When the member arrived: their acceptance on a gated forum, or their membership declaration on an open one. |
| `sponsor` | `string` (did) | No |  |
| `stamps` | `array` | No | The stamps the member wears on this forum, in order. |
| `totalPosts` | `integer` | No | Deprecated and no longer rendered: post count across every indexed forum. Kept for older clients. |
| `via` | `string` | No |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Members of a forum ordered by arrival, with atmobb profiles and the stamps they wear.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "members": {
              "description": "Each item is shaped like #memberView.",
              "items": {
                "type": "unknown"
              },
              "type": "array"
            }
          },
          "required": [
            "members"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "forum": {
            "format": "did",
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "forum"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "memberView": {
      "description": "One member as getMembers returns them.",
      "properties": {
        "did": {
          "format": "did",
          "type": "string"
        },
        "lastActive": {
          "format": "datetime",
          "type": "string"
        },
        "posts": {
          "description": "Deprecated and no longer rendered: post count on this forum. Kept for older clients.",
          "type": "integer"
        },
        "profile": {
          "description": "The member's app.atmobb.actor.profile record, when they have one.",
          "type": "unknown"
        },
        "since": {
          "description": "When the member arrived: their acceptance on a gated forum, or their membership declaration on an open one.",
          "format": "datetime",
          "type": "string"
        },
        "sponsor": {
          "format": "did",
          "type": "string"
        },
        "stamps": {
          "description": "The stamps the member wears on this forum, in order.",
          "items": {
            "ref": "app.atmobb.forum.getStamps#trayEntry",
            "type": "ref"
          },
          "maxLength": 6,
          "type": "array"
        },
        "totalPosts": {
          "description": "Deprecated and no longer rendered: post count across every indexed forum. Kept for older clients.",
          "type": "integer"
        },
        "via": {
          "knownValues": [
            "invite",
            "application",
            "founding"
          ],
          "maxLength": 32,
          "type": "string"
        }
      },
      "required": [
        "did"
      ],
      "type": "object"
    }
  },
  "id": "app.atmobb.forum.getMembers",
  "lexicon": 1
}
```