Get Channel by Name¶

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

Permissions Read-Only AssetsRead-Write Assets

Method: GET
Path: /rest/asset/v1/channel/byName.json
Tag: Channels
Operation ID: getChannelByNameUsingGET

Retrieves channels based on the provided name. Required Permissions: Read-Only Assets, Read-Write Assets

Formats¶

Request: application/x-www-form-urlencoded
Response: application/json

Request¶

Query parameters¶

Name	Type	Required	Description	Constraints
`Name`	string	Yes	Name of channel to retrieve

Example request¶

GET {{base_url}}/rest/asset/v1/channel/byName.json?Name={{Name}}
Accept: application/json

Responses¶

200 — OK¶

Schema: model: ResponseOfChannelResponse

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¶

ResponseOfChannelResponse

Source¶

Generated from swagger-asset.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.