---
updatedAt: 2025-05-19T20:07:13.000Z
agentTools:
  projectIndex: https://developer.ayyeka.com/llms.txt
---

# getChannelById channel

Returns information about the specified channel

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "RESTAPI Service",
    "description": "RESTful API",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://restapi.ayyeka.com/v2.0"
    }
  ],
  "paths": {
    "/channel/{channelId}": {
      "get": {
        "tags": [
          "channel"
        ],
        "summary": "getChannelById channel",
        "description": "Returns information about the specified channel",
        "operationId": "channel#getChannelById",
        "parameters": [
          {
            "name": "channelId",
            "in": "path",
            "description": "ID of the channel whose information should be returned",
            "required": true,
            "schema": {
              "type": "integer",
              "description": "ID of the channel whose information should be returned",
              "example": 123,
              "minimum": 1,
              "format": "int64"
            },
            "example": 123
          }
        ],
        "responses": {
          "200": {
            "description": "OK response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AkapiStoredChannel"
                },
                "example": {
                  "creation_date": "2013-08-14T16:42:09Z",
                  "device_id": 24,
                  "display_name": "Pressure",
                  "display_status_name": "Active",
                  "id": 123,
                  "on_device_num": 2,
                  "status_id": 1,
                  "type_display_name": "DIGITAL",
                  "type_id": 3
                }
              }
            }
          },
          "400": {
            "description": "bad_request: Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "401": {
            "description": "unauthorized: Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "403": {
            "description": "forbidden: Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "404": {
            "description": "not_found: Channel not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "429": {
            "description": "too_many_requests: Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "500": {
            "description": "internal_server_error: System error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          }
        },
        "security": [
          {
            "jwt_header_Authorization": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AkapiStoredChannel": {
        "type": "object",
        "properties": {
          "creation_date": {
            "type": "string",
            "description": "Creation date",
            "example": "2009-11-20T11:46:03Z",
            "format": "date-time"
          },
          "device_id": {
            "type": "integer",
            "description": "Device ID",
            "example": 24,
            "minimum": 1,
            "format": "int64"
          },
          "display_name": {
            "type": "string",
            "description": "Channel name",
            "example": "Pressure",
            "maxLength": 256
          },
          "display_status_name": {
            "type": "string",
            "description": "Status name",
            "example": "Active",
            "maxLength": 64
          },
          "id": {
            "type": "integer",
            "description": "ID is the unique id of the channel.",
            "example": 123,
            "format": "int64"
          },
          "on_device_num": {
            "type": "integer",
            "description": "On device number",
            "example": 2
          },
          "status_id": {
            "type": "integer",
            "description": "Status ID",
            "example": 1,
            "minimum": 1
          },
          "type_display_name": {
            "type": "string",
            "description": "Type name",
            "example": "DIGITAL",
            "maxLength": 32
          },
          "type_id": {
            "type": "integer",
            "description": "Type ID",
            "example": 3,
            "minimum": 1
          }
        },
        "example": {
          "creation_date": "2007-09-11T16:28:28Z",
          "device_id": 24,
          "display_name": "Pressure",
          "display_status_name": "Active",
          "id": 123,
          "on_device_num": 2,
          "status_id": 1,
          "type_display_name": "DIGITAL",
          "type_id": 3
        },
        "required": [
          "id",
          "device_id",
          "creation_date",
          "display_name",
          "status_id",
          "on_device_num",
          "type_id",
          "type_display_name",
          "display_status_name"
        ]
      },
      "Unauthorized": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Message of error",
            "example": "incorrect credentials"
          },
          "request_id": {
            "type": "string",
            "description": "Request ID",
            "example": "uGv69FKl"
          }
        },
        "description": "Unauthorized",
        "example": {
          "message": "incorrect credentials",
          "request_id": "uGv69FKl"
        },
        "required": [
          "request_id",
          "message"
        ]
      }
    },
    "securitySchemes": {
      "jwt_header_Authorization": {
        "type": "http",
        "description": "Secures endpoint by requiring a valid JWT token retrieved via the signin endpoint.",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "channel"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```