Read Channel Information

Get details about your channel, including the name, corresponding website, and default section.

URL

GET https://news-api.apple.com/channels/{channelId}

Name	Type	Description
`channelId` Required	string	The UUID of the channel to get. You can get your channel ID from News Publisher. See Use your CMS with News Publisher in News Publisher User Guide.

Status	Reason	Type	Description
200	OK Content-Type: application/json	`ChannelResponse`	The request was successful.
400	Bad Request Content-Type: application/json	`Error`	`MISSING`. You didn’t include the Channel UUID field in the request. Key path: * `INVALID_JSON`. The server can’t parse the JSON specified in the request as JSON. Key path: None. `INVALID_TYPE`. The value you specified for `channelId` is not of the correct type for that field. Key path: `channelId`.
401	Unauthorized Content-Type: application/json	`Error`	You didn’t include the `Authorization` header. Key path: None.
403	Forbidden Content-Type: application/json	`Error`	You tried to access a channel your `API` `key` doesn’t have permission to access. Key path: None.
404	Not Found Content-Type: application/json	`Error`	The endpoint you tried to access doesn’t exist. Key path: None. The channel you tried to access doesn’t exist. Key path: `channel_id.`

Use the Read Channel Information endpoint to retrieve information about the channel, list of custom fonts used in the channel (Channel), and link to the channel’s default section (ChannelLinks). See Making an HTTP Request to the Apple News API and Signing the HTTP Request in Apple News API Tutorial.

You create a channel in News Publisher, not the Apple News API. See Add or share a channel in News Publisher User Guide.