Skip to content

Tags

Tags are labels you can attach to wins for filtering and organization.

GET /api/v1/tags

Returns a paginated list of tags with win counts, ordered alphabetically.

Only tags attached to wins that you can currently access are listed. Counts include only those wins. Unused tags are not listed.

ParameterTypeDescription
pageintegerPage number (default: 1)
per_pageintegerItems per page (default: 25, max: 100)
Terminal window
curl https://app.myhypedoc.com/api/v1/tags \
-H "Authorization: Bearer $HYPEDOC_TOKEN"

PATCH /api/v1/tags/:id

Renames a tag. The new name applies to all wins that use this tag.

You must own the tag and have permission to edit every win that uses it.

ParameterTypeRequiredDescription
tag[name]stringYesNew name for the tag (max 30 characters)
Terminal window
curl -X PATCH https://app.myhypedoc.com/api/v1/tags/1 \
-H "Authorization: Bearer $HYPEDOC_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tag": {"name": "high-impact"}}'
StatusDescription
403You cannot edit one or more wins that use this tag
404Tag not found
422Validation error (e.g. name already taken, blank, or too long)

DELETE /api/v1/tags/:id

Deletes a tag. Wins that had this tag are kept; only the tag association is removed.

You must own the tag and have permission to edit every win that uses it.

Terminal window
curl -X DELETE https://app.myhypedoc.com/api/v1/tags/3 \
-H "Authorization: Bearer $HYPEDOC_TOKEN"

Returns 204 No Content on success.

StatusDescription
403You cannot edit one or more wins that use this tag
404Tag not found