social.colibri.beta.channel.getChannel Documentation (EN)

main query

Gets one channel.

Parameters

channel string space-ref Required

The channel to get.

Output

Encodingapplication/json

channel refsocial.colibri.beta.community.defs#channelView Required

The requested channel.

Errors

AuthRequired The request has no valid service auth.

Forbidden The requesting user may not read this channel.

ChannelNotFound No channel matches the given space reference.

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

channel * The channel to get.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "Forbidden",
      "description": "The requesting user may not read this channel."
    },
    {
      "name": "ChannelNotFound",
      "description": "No channel matches the given space reference."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "channel"
      ],
      "properties": {
        "channel": {
          "ref": "social.colibri.beta.community.defs#channelView",
          "type": "ref",
          "description": "The requested channel."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "channel"
    ],
    "properties": {
      "channel": {
        "type": "string",
        "format": "space-ref",
        "description": "The channel to get."
      }
    }
  },
  "description": "Gets one channel."
}