Get a reference page

get

https://api.readme.com/v2/branches/{branch}/reference/{slug}

Get a page from the API Reference section of your ReadMe project.

📘
This route is only available to projects that are using ReadMe Refactored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

branch

string

required

(v{0,1})(stable|([0-9]+)(?:\.([0-9]+))?(?:\.([0-9]+))?(-.*)?)(_(.*))?

Project version number, stable for your project's stable version, or a valid branch name.

slug

string

required

([a-z0-9-_ ]|[^\\x00-\\x7F])+

A URL-safe representation of the resource.

Query Params

expand_reusable_content

string

enum

Defaults to false

Whether to replace any reusable content tags in the page body with the content of the blocks they point at. Defaults to false, which returns the tags as they were authored. The attached API definition always comes back reduced when this is true, whatever reduce is set to.

Allowed:

reduce

string

enum

Defaults to true

Whether or not to reduce the attached API definition. Defaults to true if not specified (subject to change while API v2 is still in beta).

Allowed:

Headers

if-none-match

string

An ETag value to compare against the resource.

Responses

200OK

304Not Modified