social.colibri.beta.community.getInvitation

colibri.social

Documentation

Resolves an invitation code, so a client can show what it leads to before the user accepts. This is readable without membership.

main query

Resolves an invitation code, so a client can show what it leads to before the user accepts. This is readable without membership.

Parameters

code string Required

The invitation code to resolve.

Output

Encodingapplication/json

Errors

InvitationNotFound No invitation exists with that code.
Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The invitation code to resolve.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "InvitationNotFound",
      "description": "No invitation exists with that code."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "invitation",
        "community"
      ],
      "properties": {
        "community": {
          "ref": "social.colibri.beta.community.defs#communityView",
          "type": "ref",
          "description": "The community the invitation leads to."
        },
        "invitation": {
          "ref": "social.colibri.beta.community.defs#invitationView",
          "type": "ref",
          "description": "The resolved invitation."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "code"
    ],
    "properties": {
      "code": {
        "type": "string",
        "description": "The invitation code to resolve."
      }
    }
  },
  "description": "Resolves an invitation code, so a client can show what it leads to before the user accepts. This is readable without membership."
}

Lexicon Garden

@