# town.delve.unspecced.getSuggestionsSkeleton

> 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.getSuggestionsSkeleton)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.unspecced.getSuggestionsSkeleton/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.unspecced.getSuggestionsSkeleton/examples)

## Definitions

### `town.delve.unspecced.getSuggestionsSkeleton`

**Type**: `query`

Get a skeleton of suggested actors. Intended to be called and then hydrated through app.bsky.actor.getSuggestions

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |
| `relativeToDid` | `string` (did) | No | DID of the account to get suggestions relative to. If not provided, suggestions will be based on the viewer. |
| `viewer` | `string` (did) | No | DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actors` | `array` | Yes |  |
| `cursor` | `string` | No |  |
| `recId` | `integer` | No | DEPRECATED: use recIdStr instead. |
| `recIdStr` | `string` | No | Snowflake for this recommendation, use when submitting recommendation events. |
| `relativeToDid` | `string` (did) | No | DID of the account these suggestions are relative to. If this is returned undefined, suggestions are based on the viewer. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get a skeleton of suggested actors. Intended to be called and then hydrated through app.bsky.actor.getSuggestions",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "actors": {
              "items": {
                "ref": "town.delve.unspecced.defs#skeletonSearchActor",
                "type": "ref"
              },
              "type": "array"
            },
            "cursor": {
              "type": "string"
            },
            "recId": {
              "description": "DEPRECATED: use recIdStr instead.",
              "type": "integer"
            },
            "recIdStr": {
              "description": "Snowflake for this recommendation, use when submitting recommendation events.",
              "type": "string"
            },
            "relativeToDid": {
              "description": "DID of the account these suggestions are relative to. If this is returned undefined, suggestions are based on the viewer.",
              "format": "did",
              "type": "string"
            }
          },
          "required": [
            "actors"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "relativeToDid": {
            "description": "DID of the account to get suggestions relative to. If not provided, suggestions will be based on the viewer.",
            "format": "did",
            "type": "string"
          },
          "viewer": {
            "description": "DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.",
            "format": "did",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "town.delve.unspecced.getSuggestionsSkeleton",
  "lexicon": 1
}
```