Web Service Endpoint

Read Article Information

Retrieve information about an article, such as the revision number and maturity rating.

URL

GET https://news-api.apple.com/articles/{articleId}

Path Parameters

articleId
string
(Required)

UUID of the article to get.

Response Codes

OK

The request was successful.

400 Bad Request
Bad Request
  • MISSING. The Article UUID field was not supplied in the request. Key path: article_id.

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

401 Unauthorized
Unauthorized

The Authorization header was not supplied. Key path: N/A

403 Forbidden
Forbidden

You tried to access an article your API key does not have permission to access. Key path: N/A

404 Not Found
Not Found
  • The endpoint you tried to access does not exist. Key path: N/A

  • The article you tried to access does not exist. Key path: articleId.

Discussion

Use the Read Article Information endpoint to retrieve information about the article (Article), article links (ArticleLinks), meta (Meta), and optional metadata fields (Create Article Metadata Fields).

Example

GET /articles/a3caeb08-b9db-4002-b379-cde305d74be7 HTTP/1.1Host: news-api.apple.comAccept: application/jsonAuthorization: HHMAC; key="1e3gfc5e-e9f8-4232-a6be-17bf40edad09"; signature="irqw07DCRQLtx/40Z2VhNc7sl3nB1PKII374R7AHjUQ="; date="2015-02-28T00:03:31Z"

See Also

Articles

Create an Article

Publish an article to your channel.

Search Articles in a Channel

See a list of all articles in a channel that match the specified search criteria.

Search Articles in a Section

See a list of all articles in a section that match the specified search criteria.

Update an Article

Update an existing article in your channel.

Delete an Article

Delete the specified article from your channel.

object Create Article Metadata Fields

See the optional metadata fields for the create article request.

object ArticleLinksRequest

See the required field for the create article request.

object Update Article Metadata Fields

See the metadata fields for the update article request.

object Article

See the fields returned by the article endpoints.

object ArticleResponse

See which objects make up the create article, read article, and update article responses.

object ArticleLinksResponse

See the links returned by the article endpoints.

object SearchResponse

See the fields returned by the search article endpoints.

object Meta

See the object that wraps the throttling information that's returned for the create article and read article endpoints.

object Throttling

See the object that wraps the throttling information that's returned for the create article and update article endpoints.