chat.bsky.group.getJoinLinkPreviews Documentation (EN)

main query

Get public information about groups from join links. The output array matches the input codes one-to-one by position (and each view also carries its 'code'). Disabled codes return a disabledJoinLinkPreviewView, and codes that do not map to a previewable link return an invalidJoinLinkPreviewView.

Parameters

codes array of string Required

No description available.

Output

Encodingapplication/json

joinLinkPreviews array Required

No description available.

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

codes *

View raw schema

{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "joinLinkPreviews"
      ],
      "properties": {
        "joinLinkPreviews": {
          "type": "array",
          "items": {
            "refs": [
              "chat.bsky.group.defs#joinLinkPreviewView",
              "chat.bsky.group.defs#disabledJoinLinkPreviewView",
              "chat.bsky.group.defs#invalidJoinLinkPreviewView"
            ],
            "type": "union"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "codes"
    ],
    "properties": {
      "codes": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "maxLength": 50,
        "minLength": 1
      }
    }
  },
  "description": "Get public information about groups from join links. The output array matches the input codes one-to-one by position (and each view also carries its 'code'). Disabled codes return a disabledJoinLinkPreviewView, and codes that do not map to a previewable link return an invalidJoinLinkPreviewView."
}