# town.delve.unspecced.getSuggestedOnboardingUsers

> Published by [delve.town](https://lexicon.garden/identity/did:plc:qzqct2rrq4u2gmy5g3mjxske)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.unspecced.getSuggestedOnboardingUsers)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.unspecced.getSuggestedOnboardingUsers/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.unspecced.getSuggestedOnboardingUsers/examples)

## Definitions

### `town.delve.unspecced.getSuggestedOnboardingUsers`

**Type**: `query`

Get a list of suggested users for onboarding

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `category` | `string` | No | Category of users to get suggestions for. |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actors` | `array` | Yes |  |
| `recId` | `string` | No | DEPRECATED: use recIdStr instead. |
| `recIdStr` | `string` | No | Snowflake for this recommendation, use when submitting recommendation events. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get a list of suggested users for onboarding",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "actors": {
              "items": {
                "ref": "town.delve.actor.defs#profileView",
                "type": "ref"
              },
              "type": "array"
            },
            "recId": {
              "description": "DEPRECATED: use recIdStr instead.",
              "type": "string"
            },
            "recIdStr": {
              "description": "Snowflake for this recommendation, use when submitting recommendation events.",
              "type": "string"
            }
          },
          "required": [
            "actors"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "category": {
            "description": "Category of users to get suggestions for.",
            "type": "string"
          },
          "limit": {
            "default": 25,
            "maximum": 50,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "town.delve.unspecced.getSuggestedOnboardingUsers",
  "lexicon": 1
}
```