---
updatedAt: 2025-05-19T20:48:37.000Z
agentTools:
  projectIndex: https://developers.happeo.com/llms.txt
---

# Retrieve a channel

Retrieves a channel by ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "version": "0.0.1",
    "title": "Happeo Channels API",
    "description": "API to create, list, retrieve, update, and archive channels.",
    "license": {
      "name": "UNLICENSED"
    },
    "termsOfService": "https://www.happeo.com/tos",
    "contact": {
      "name": "API Support",
      "email": "support@happeo.com"
    }
  },
  "servers": [
    {
      "url": "https://api.happeo.com",
      "description": "Production server"
    },
    {
      "url": "https://api.staging.unvrs.io",
      "description": "Staging server"
    }
  ],
  "components": {
    "securitySchemes": {
      "headerAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-happeo-apikey",
        "description": "API key passed in the headers."
      }
    },
    "schemas": {
      "id": {
        "type": "string",
        "description": "The entity id.",
        "example": "123213"
      },
      "name": {
        "type": "string",
        "description": "Channel name: very short text.",
        "example": "Knitting club",
        "nullable": false
      },
      "description": {
        "type": "string",
        "description": "Channel description: short text.",
        "example": "Everything about knitting: yarns, kittens, the whole nine yards."
      },
      "image": {
        "type": "string",
        "description": "Channel header image URL.",
        "nullable": true,
        "example": "https://example.org/logo"
      },
      "color": {
        "type": "string",
        "description": "Channel header color as CSS RGB value.",
        "nullable": true,
        "example": "#1066b7"
      },
      "hashtags": {
        "type": "array",
        "items": {
          "type": "string",
          "description": "A hashtag: lower case words separated by single underscore characters, with a leading \"#\".",
          "example": "#pure_awesomeness"
        }
      },
      "status": {
        "type": "string",
        "description": "Channel status.\n\nPossible values:\n* `active`: The channel is active. It can appear in normal channel list responses, can be viewed and added posts to, etc.\n* `archived`: The channel has been archived. It won't appear in normal list responses, cannot be added posts to, etc.",
        "default": "active",
        "example": "archived"
      },
      "visibility": {
        "type": "string",
        "description": "Channel visibility.\n\nPossible values:\n* `open`: The channel and activity therein are visible to users in the primary organization or trusted organizatios of the channel owner.\n* `closed`: The channel is visible to users in the primary organization or trusted organizatios of the channel owner, but channel activity is not. To see channel activity, one must request membership to the channel.\n* `secret`: The channel and activity therein are only visible to its members.",
        "default": "secret",
        "example": "open"
      },
      "ChannelOutputObject": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/id"
          },
          "name": {
            "$ref": "#/components/schemas/name"
          },
          "description": {
            "$ref": "#/components/schemas/description"
          },
          "hashtags": {
            "$ref": "#/components/schemas/hashtags"
          },
          "status": {
            "$ref": "#/components/schemas/status"
          },
          "visibility": {
            "$ref": "#/components/schemas/visibility"
          },
          "image": {
            "$ref": "#/components/schemas/image"
          },
          "color": {
            "$ref": "#/components/schemas/color"
          }
        }
      }
    },
    "parameters": {
      "channelId": {
        "in": "path",
        "name": "id",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/id"
        },
        "description": "The channel ID."
      }
    },
    "responses": {
      "CompleteChannelResponse": {
        "description": "A complete channel response.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ChannelOutputObject"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "headerAuth": []
    }
  ],
  "paths": {
    "/channels/{id}": {
      "get": {
        "summary": "Retrieve a channel",
        "description": "Retrieves a channel by ID.",
        "operationId": "getChannel",
        "parameters": [
          {
            "$ref": "#/components/parameters/channelId"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/CompleteChannelResponse"
          }
        },
        "tags": [
          "Channels"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Channels",
      "description": "Channel operations."
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```