Skip to content
ShaireDevelopers

tags

4 endpoints.

get/api/tags#

Request
curl https://api.shairelabs.com/api/tags \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · Tag[]

idstring · uuid*
workspaceIdstring · uuid*
namestring*
huestring*
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
tagGroupIdstring · uuid | null*

Also answers 401 and 403. SeeErrors.

post/api/tags#

workspace:adminadmin only

Body

namestring*
min length 1 · max length 60
huestring
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
tagGroupIdstring · uuid | null
Request
curl https://api.shairelabs.com/api/tags \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example"}'

Response · 201 · Tag

idstring · uuid*
workspaceIdstring · uuid*
namestring*
huestring*
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
tagGroupIdstring · uuid | null*

Also answers 401 and 403. SeeErrors.

patch/api/tags/{id}#

workspace:adminadmin only

Path

idstring*

Body

namestring
min length 1 · max length 60
huestring
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
tagGroupIdstring · uuid | null
Request
curl https://api.shairelabs.com/api/tags/$TAG_ID \
  -X PATCH \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · Tag

idstring · uuid*
workspaceIdstring · uuid*
namestring*
huestring*
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
tagGroupIdstring · uuid | null*

Also answers 401 and 403. SeeErrors.

delete/api/tags/{id}#

workspace:adminadmin only

Path

idstring*
Request
curl https://api.shairelabs.com/api/tags/$TAG_ID \
  -X DELETE \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 204

Also answers 401 and 403. SeeErrors.