Retrieve all realtime channels - Xano Documentation

GET

workspace

{workspace_id}

realtime

channel

Retrieve all realtime channels

curl --request GET \
  --url https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime/channel \
  --header 'Authorization: Bearer <token>'

{
  "curPage": 123,
  "nextPage": 123,
  "prevPage": 123,
  "items": [
    {
      "id": 1,
      "name": "Channel Name",
      "active": true,
      "xanoscript": {
        "value": "<string>",
        "message": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id

integer<int64>

required

Query Parameters

include_xanoscript

boolean

default:false

page

integer<int64>

default:1

per_page

integer<int64>

default:50

string

default:""

sort

enum<string>

default:name

Available options:

name

order

enum<string>

default:desc

Available options:

asc,

desc

Response

Success!

curPage

integer<int64>

integer<int64> | null

items

object[]

Show child attributes

Delete a realtime channel permanently. This action cannot be undone

Create a new realtime channel using XanoScript

⌘I

Retrieve all realtime channels

curl --request GET \
  --url https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/realtime/channel \
  --header 'Authorization: Bearer <token>'

{
  "curPage": 123,
  "nextPage": 123,
  "prevPage": 123,
  "items": [
    {
      "id": 1,
      "name": "Channel Name",
      "active": true,
      "xanoscript": {
        "value": "<string>",
        "message": "<string>"
      }
    }
  ]
}