Get Channel by Name

GET /rest/asset/v1/channel/byName.json

Retrieves channels based on the provided name.

Operation ID: getChannelByNameUsingGET
Permissions: Read-Only Assets, Read-Write Assets
Request format: application/x-www-form-urlencoded
Returns: ResponseOfChannelResponse

Parameters

Query 1

Name string required

Name of channel to retrieve

Responses

200 OK ResponseOfChannelResponse

errors array of Error

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

requestId string

result array of ChannelResponse

Model ChannelResponse

applicableProgramType string required

Types of programs to which the channel can apply

createdAt string (date-time) required

Datetime when the channel was created

id integer (int32) required

Id of the Channel

name string required

Name of the Channel

progressionStatuses array of ChannelProgression

List of available statuses for members of programs with the channel

Model ChannelProgression

description string

Description of the program status

hidden boolean

Whether the status has been hidden

name string

Name of the status

type string

Type of the status

step integer (int32)

Step number of the status

success boolean

Whether this status is a success step for program members

updatedAt string (date-time) required

Datetime when the channel was most recently updated

success boolean

warnings array of string

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "applicableProgramType": "string",
      "createdAt": "2026-01-15T10:30:00Z",
      "id": 123,
      "name": "Example name",
      "progressionStatuses": [
        {
          "description": "string",
          "hidden": true,
          "name": "Example name",
          "type": "string",
          "step": 123,
          "success": true
        }
      ],
      "updatedAt": "2026-01-15T10:30:00Z"
    }
  ],
  "success": true,
  "warnings": [
    "string"
  ]
}

Referenced models

Generated from swagger-asset.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.