Skip to main content

Site Navigation

Your Account

Choose Language


Create, edit, delete and list guides and guide steps

GET /guides

Returns a list of all public guides, sorted by guideid.

GET /guides/{guideid}

Returns a comprehensive list of attributes about a guide.

GET /guides/{guideid}/tags

Get all tags on a guide

POST /guides

Create a new guide

PATCH /guides/{guideid}

Updates only the provided fields of an existing guide.

DELETE /guides/{guideid}

Permanently delete a guide

PUT /guides/{guideid}/completed

Mark a guide as completed for the currently authenticated user. This action gives reputation to the primary author of this guide. This action can only be performed once per guide and is rate limited to prevent spamming.

DELETE /guides/{guideid}/completed

Uncomplete a previously completed guide.

PUT /guides/{guideid}/public

Make a guide public

DELETE /guides/{guideid}/public

Make a guide private

POST /guides/{guideid}/steps

Add a step to an existing guide.

PATCH /guides/{guideid}/steps/{stepid}

Edit a guide step

DELETE /guides/{guideid}/steps/{stepid}

Remove a guide step

PUT /guides/{guideid}/steporder

Reorder guide steps.

GET /guides/{guideid}/users

List users allowed to view a private guide.

PUT /guides/{guideid}/users/{userid}

Add a user allowed to view a private guide.

DELETE /guides/{guideid}/users/{userid}

Remove a user allowed to view a private guide.

GET /guides/{guideid}/teams

Get a list of teams that can view this guide. If a guide is private, teams added by authorized users can view the guide.

PUT /guides/{guideid}/teams/{teamid}

Add a team that is allowed to view this private guide.

DELETE /guides/{guideid}/teams/{teamid}

No longer allow a specified team to view a guide.

GET /guides/releases

Show all release versions sorted by creation date.

DELETE /guides/releases/{releaseid}

Cancel a pending release version. Must be author of release or have admin privileges.

GET /guides/{guideid}/releases

Show all of a guide's release versions in descending release date order.

POST /guides/releases

Add a new release version for a guide.