API Reference
Start typing to search…

Get Roadmaps

get https://{defaultHost}/api/v2/roadmaps

Returns a list of all Roadmaps accessible by the authenticated user. By default, it does not return versions. You can change this behavior by modifying the filtering (q) parameter.

Query Params
integer
Defaults to 1

Indicates which page number to retrieve (based on a given page size)

integer
Defaults to 200

The amount of items to return with each page (default: 200, max: 500)

q
object

Filter and sort query. (Filterable attributes: id,name,is_version,created_at,updated_at). Visit our filtering docs for more information about how filtering works.

boolean
Defaults to false

Whether or not to exclude roadmaps that have been shared with the authenticated user (i.e. only show owned roadmaps). Defaults to false.

boolean
Defaults to false

Whether or not to only show roadmaps that the authenticated user can edit. Defaults to false.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?