# social.coves.community.getMembers

> Published by [coves.social](https://lexicon.garden/identity/did:web:coves.social)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:web:coves.social/social.coves.community.getMembers)
- [Documentation](https://lexicon.garden/lexicon/did:web:coves.social/social.coves.community.getMembers/docs)
- [Examples](https://lexicon.garden/lexicon/did:web:coves.social/social.coves.community.getMembers/examples)

## Definitions

### `social.coves.community.getMembers`

**Type**: `query`

Get list of users with membership status in a community

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `sort` | `string` | No |  |
| `limit` | `integer` | No |  |
| `cursor` | `string` | No |  |
| `community` | `string` (at-identifier) | Yes | DID or handle of the community |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `members` | `array` | Yes |  |

### `social.coves.community.getMembers#memberView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `avatar` | `string` (uri) | No |  |
| `handle` | `string` (handle) | No |  |
| `postCount` | `integer` | No | Number of posts in this community |
| `reputation` | `integer` | No |  |
| `displayName` | `string` | No |  |
| `isModerator` | `boolean` | No |  |
| `memberSince` | `string` (datetime) | Yes |  |
| `commentCount` | `integer` | No | Number of comments in this community |

## Raw Schema

```json
{
  "id": "social.coves.community.getMembers",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "members"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "maxLength": 500
            },
            "members": {
              "type": "array",
              "items": {
                "ref": "#memberView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "community"
        ],
        "properties": {
          "sort": {
            "type": "string",
            "default": "reputation",
            "maxLength": 64,
            "knownValues": [
              "reputation",
              "recent",
              "alphabetical"
            ]
          },
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string",
            "maxLength": 500
          },
          "community": {
            "type": "string",
            "format": "at-identifier",
            "description": "DID or handle of the community"
          }
        }
      },
      "description": "Get list of users with membership status in a community"
    },
    "memberView": {
      "type": "object",
      "required": [
        "did",
        "memberSince"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "avatar": {
          "type": "string",
          "format": "uri"
        },
        "handle": {
          "type": "string",
          "format": "handle"
        },
        "postCount": {
          "type": "integer",
          "minimum": 0,
          "description": "Number of posts in this community"
        },
        "reputation": {
          "type": "integer",
          "minimum": 0
        },
        "displayName": {
          "type": "string",
          "maxLength": 1280,
          "maxGraphemes": 128
        },
        "isModerator": {
          "type": "boolean"
        },
        "memberSince": {
          "type": "string",
          "format": "datetime"
        },
        "commentCount": {
          "type": "integer",
          "minimum": 0,
          "description": "Number of comments in this community"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```