API Reference
  1. ReadMe API
  2. Guides

Get a guides page

get
https://api.readme.com/v2/branches//guides/

Get a page from the Guides section of your ReadMe project.

📘

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
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.

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

A URL-safe representation of the resource.

Query Params
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.

Allowed:
Headers
string

An ETag value to compare against the resource.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading

Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?