Contents

List All Sections

See a list of available sections in your channel.

URL

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

Path Parameters

NameTypeDescription
channelId Requiredstring

The UUID of the channel. You can get your channel ID from News Publisher. See Use your CMS with News Publisher in News Publisher User Guide.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
SectionResponse

The request was successful.

400Bad Request
Content-Type: application/json
Error

  • MISSING. You didn’t include the section UUID field in the request. Key path: articleId.

  • INVALID_TYPE. The value you specified for the section is not of the correct type for that field. Key path: articleId

401Unauthorized
Content-Type: application/json
Error

You didn’t include the Authorization header. Key path: None.

403Forbidden
Content-Type: application/json
Error

You tried to access a channel your API key doesn’t have permission to access. Key path: None.

404Not Found
Content-Type: application/json
Error

  • The endpoint you tried to access doesn’t exist. Key path: None.

  • The section you tried to access doesn’t exist. Key path: sectionId.

Discussion

A List All Sections request returns a list of all sections for a channel. A section is a grouping of articles on a particular topic; for example, Sports, Silicon Valley, or Politics.

You create sections in News Publisher. Sections aren’t created via the API; they are set up separately in News Publisher. See Add and manage sections in News Publisher User Guide. Every channel has a default section, even if no other sections are defined. The default section URL is included in the Read Channel Information response.

Example

See Also

Sections