Get a guides page

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

πŸ“˜

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

🚧

ReadMe's API v2 is currently in beta.

This API and its docs are a work in progress. While we don’t expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to check out our API migration guide, and feel free to reach out if you have any questions or feedback!

Log in to see full request history
Path Params
string
required

Project version number or stable.

string
required

A URL-safe representation of the resource.

Response

Response body
object
data
object
required
string
Defaults to enabled

Allow indexing by robots.

enabled disabled

category
object
required
content
object
required
href
object
required
metadata
object
required
parent
object
required
privacy
object
required
project
object
required
renderable
object
required
string
required
length β‰₯ 1

The accessible URL slug for the page.

string
Defaults to current

current deprecated

string
required
string
Defaults to basic

api_config basic endpoint link

date-time
required

An ISO 8601 formatted date for when the page was updated.

string
required

A URI to the page resource.

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