# app.atmobb.forum.getMembership

> 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.getMembership)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getMembership/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dqnwiguwsbb6uwrm7a2rsff2/app.atmobb.forum.getMembership/examples)

## Definitions

### `app.atmobb.forum.getMembership`

**Type**: `query`

One account's membership standing with a gated forum: whether the forum has accepted them, since when, who sponsored them, and whom they have sponsored. Derived from the forum's public acceptMember and revokeMember actions.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (did) | Yes |  |
| `forum` | `string` (did) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `accepted` | `boolean` | Yes |  |
| `since` | `string` (datetime) | No |  |
| `sponsor` | `string` (did) | No |  |
| `sponsored` | `array` | Yes |  |
| `tray` | `array` | No | Every stamp the actor holds on this forum. |
| `via` | `string` | No |  |
| `worn` | `array` | No | Ids from the tray the actor wears, in order. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "One account's membership standing with a gated forum: whether the forum has accepted them, since when, who sponsored them, and whom they have sponsored. Derived from the forum's public acceptMember and revokeMember actions.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "accepted": {
              "type": "boolean"
            },
            "since": {
              "format": "datetime",
              "type": "string"
            },
            "sponsor": {
              "format": "did",
              "type": "string"
            },
            "sponsored": {
              "items": {
                "type": "unknown"
              },
              "type": "array"
            },
            "tray": {
              "description": "Every stamp the actor holds on this forum.",
              "items": {
                "ref": "app.atmobb.forum.getStamps#trayEntry",
                "type": "ref"
              },
              "type": "array"
            },
            "via": {
              "type": "string"
            },
            "worn": {
              "description": "Ids from the tray the actor wears, in order.",
              "items": {
                "maxLength": 300,
                "type": "string"
              },
              "maxLength": 6,
              "type": "array"
            }
          },
          "required": [
            "accepted",
            "sponsored"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "actor": {
            "format": "did",
            "type": "string"
          },
          "forum": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "forum",
          "actor"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "app.atmobb.forum.getMembership",
  "lexicon": 1
}
```