# app.zeens.getSuggestedUsers

> Published by [zeens.app](https://lexicon.garden/identity/did:plc:pwpuqwge6g7xrjmfbw73uycw)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getSuggestedUsers)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getSuggestedUsers/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getSuggestedUsers/examples)

## Definitions

### `app.zeens.getSuggestedUsers`

**Type**: `query`

Suggested accounts for a viewer in one query: members with at least minPosts Zeens posts, ordered by posts in the last 30 days then most recent post, excluding the viewer and accounts the viewer already follows. An optional pinned DID leads the list unless it is already followed.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum accounts to return (default 5, max 25). |
| `minPosts` | `integer` | No | Minimum number of Zeens posts an account needs to be suggested (default 5). |
| `pin` | `string` | No | DID to lead the list regardless of post count, unless the viewer already follows it. |
| `viewer` | `string` | No | DID of the viewer. The viewer and everyone they follow are excluded. |

#### Output

**Encoding**: `application/json`

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Suggested accounts for a viewer in one query: members with at least minPosts Zeens posts, ordered by posts in the last 30 days then most recent post, excluding the viewer and accounts the viewer already follows. An optional pinned DID leads the list unless it is already followed.",
      "output": {
        "encoding": "application/json"
      },
      "parameters": {
        "properties": {
          "limit": {
            "description": "Maximum accounts to return (default 5, max 25).",
            "type": "integer"
          },
          "minPosts": {
            "description": "Minimum number of Zeens posts an account needs to be suggested (default 5).",
            "type": "integer"
          },
          "pin": {
            "description": "DID to lead the list regardless of post count, unless the viewer already follows it.",
            "type": "string"
          },
          "viewer": {
            "description": "DID of the viewer. The viewer and everyone they follow are excluded.",
            "type": "string"
          }
        },
        "type": "params"
      },
      "target_collection": "app.zeens.postMeta",
      "type": "query"
    }
  },
  "id": "app.zeens.getSuggestedUsers",
  "lexicon": 1
}
```
