social.colibri.community.getInvitation Documentation (EN)

main query

Resolves an invitation code to its community, hydrated with the community's public details for the invite accept screen.

Parameters

code string Required

No description available.

Output

Encodingapplication/json

Schemalex:social.colibri.community.defs#resolvedInvitationView

Errors

AuthRequired Missing, malformed, or unverifiable service auth.

Forbidden The caller lacks the permission this method requires.

InvalidRequest A parameter or body field was missing or malformed.

NotFound The referenced record does not exist.

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

code *

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "Missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the permission this method requires."
    },
    {
      "name": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    },
    {
      "name": "NotFound",
      "description": "The referenced record does not exist."
    }
  ],
  "output": {
    "schema": {
      "ref": "lex:social.colibri.community.defs#resolvedInvitationView",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "code"
    ],
    "properties": {
      "code": {
        "type": "string"
      }
    }
  },
  "description": "Resolves an invitation code to its community, hydrated with the community's public details for the invite accept screen."
}