Customer StoriesReadMe Blog
API Reference
Start typing to search…

Get category

get
https://dash.readme.com/api/v1/categories/

Returns the category with this slug.

❗

API v1 and this route are not available to projects that are using ReadMe Refactored. Check out our API migration guide for information on how to migrate to the new API.

Path Params
string
required

A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category "Getting Started", enter the slug "getting-started".

Headers
string

Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.

Responses
200

The category exists and has been returned.

Updated 9 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago