town.delve.unspecced.getSuggestedOnboardingUsers Documentation (EN)

main query

Get a list of suggested users for onboarding

Parameters

category string Optional

Category of users to get suggestions for.

limit integer Optional

No description available.

Output

Encodingapplication/json

actors array Required

No description available.

recId string Optional

DEPRECATED: use recIdStr instead.

recIdStr string Optional

Snowflake for this recommendation, use when submitting recommendation events.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

category Category of users to get suggestions for.

limit

View raw schema

{
  "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"
}