API Reference

Get a reference page

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

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

string
required

A URL-safe representation of the resource.

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

An ETag value to compare against the resource.

Responses

Updated about 2 months ago

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

Updated about 2 months ago