Developer API

The GC Articles REST Application Programming Interface or API is organized around REST and is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. The API uses built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and supports cross-origin resource sharing to allow you to interact securely with the API from a client-side web application.

The REST API uses JSON exclusively as the request and response format, including error responses. While the REST API does not completely conform to the HAL standard, it does implement HAL’s ._links and ._embedded properties for linking API resources, and is fully discoverable via hyperlinks in the responses.

This API reference provides information on the specific endpoints available through the API, their parameters, and their response data format.

API Endpoint

GC Articles is based on the open source content management platform WordPress. This allows GC Articles to support all the same API actions as WordPress and follow the same format.

The GC Articles API can be found at https://articles.alpha.canada.ca/wp-json/

The API exposes self-documentation at the index endpoint, or via an OPTIONS request to any endpoint, allowing human- or machine-discovery of endpoint capabilities.

demo installation of the API for testing purposes is available at https://demo.wp-api.org/wp-json/; this site supports auto-discovery, and provides read-only demo data.

REST API Developer Endpoint Reference 

ResourceBase Route
Posts/wp/v2/posts
Post Revisions/wp/v2/posts/<id>/revisions
Categories/wp/v2/categories
Pages/wp/v2/pages
Page Revisions/wp/v2/pages/<id>/revisions
Comments/wp/v2/comments
Taxonomies/wp/v2/taxonomies
Media/wp/v2/media
Users/wp/v2/users
Post Types/wp/v2/types
Post Statuses/wp/v2/statuses
Settings/wp/v2/settings
Themes/wp/v2/themes
Search/wp/v2/search
Block Types/wp/v2/block-types
Blocks/wp/v2/blocks
Block Revisions/wp/v2/blocks/<id>/autosaves/
Block Renderer/wp/v2/block-renderer
Block Directory Items/wp/v2/block-directory/search
Plugins/wp/v2/plugins

Authenticated Content Management Actions

The REST API provides public data accessible to any client anonymously, as well as private data only available after authentication. Once authenticated the REST API supports most content management actions, allowing you to build alternative dashboards for a site, enhance your plugins with more responsive management tools, or build complex single-page applications.

Date modified: