Skip to content
ShaireDevelopers
Get a token

folders

6 endpoints.

get/api/folders#

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

Response · 200 · Folder[]

idstring · uuid*
workspaceIdstring · uuid*
parentIdstring · uuid | null*
namestring*
pathstring*
positionstring*
statusGroupIdstring · uuid | null*
effectiveStatusGroupIdstring · uuid*
tagGroupIds(string · uuid)[]*
effectiveTagGroupIds(string · uuid)[] | null*
privateboolean*
protectedboolean*
effectiveProtectedboolean*
glyphstring | null*
createdAtstring*

Also answers 401 and 403. SeeErrors.

post/api/folders#

tickets:write

Body

namestring*
min length 1 · max length 120
parentIdstring · uuid | null
afterIdstring · uuid | null
statusGroupIdstring · uuid | null
Request
curl https://api.shairelabs.com/api/folders \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"example"}'

Response · 201 · Folder

idstring · uuid*
workspaceIdstring · uuid*
parentIdstring · uuid | null*
namestring*
pathstring*
positionstring*
statusGroupIdstring · uuid | null*
effectiveStatusGroupIdstring · uuid*
tagGroupIds(string · uuid)[]*
effectiveTagGroupIds(string · uuid)[] | null*
privateboolean*
protectedboolean*
effectiveProtectedboolean*
glyphstring | null*
createdAtstring*

Also answers 401 and 403. SeeErrors.

patch/api/folders/{id}#

tickets:write

Path

idstring*

Body

namestring
min length 1 · max length 120
glyphstring | null
clipboard-listflagkanbanlayout-listlist-checksmilestonetabletargetbriefcasebuildingchart-barchart-piehandshakepresentationtrending-upusersbugcloudcodecpudatabasegit-branchserverterminalhammerkeylockpackageplugsettingsshieldwrenchbrushcameraimagelayersmusicpalettepen-toolvideobellinboxmailmegaphonemessage-squaremicphonesendawardcredit-carddollar-signgiftreceiptshopping-carttrophytruckbook-opengraduation-capheartlightbulbrocketsparklesstarzap
Request
curl https://api.shairelabs.com/api/folders/$FOLDER_ID \
  -X PATCH \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · Folder

idstring · uuid*
workspaceIdstring · uuid*
parentIdstring · uuid | null*
namestring*
pathstring*
positionstring*
statusGroupIdstring · uuid | null*
effectiveStatusGroupIdstring · uuid*
tagGroupIds(string · uuid)[]*
effectiveTagGroupIds(string · uuid)[] | null*
privateboolean*
protectedboolean*
effectiveProtectedboolean*
glyphstring | null*
createdAtstring*

Also answers 401 and 403. SeeErrors.

post/api/folders/{id}/move#

tickets:write

Path

idstring*

Body

parentIdstring · uuid | null*
afterIdstring · uuid | null
Request
curl https://api.shairelabs.com/api/folders/$FOLDER_ID/move \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"parentId":"00000000-0000-0000-0000-000000000000"}'

Response · 200 · Folder

idstring · uuid*
workspaceIdstring · uuid*
parentIdstring · uuid | null*
namestring*
pathstring*
positionstring*
statusGroupIdstring · uuid | null*
effectiveStatusGroupIdstring · uuid*
tagGroupIds(string · uuid)[]*
effectiveTagGroupIds(string · uuid)[] | null*
privateboolean*
protectedboolean*
effectiveProtectedboolean*
glyphstring | null*
createdAtstring*

Also answers 401 and 403. SeeErrors.

patch/api/folders/{id}/status-group#

tickets:write

Path

idstring*

Body

statusGroupIdstring · uuid | null*
Request
curl https://api.shairelabs.com/api/folders/$FOLDER_ID/status-group \
  -X PATCH \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"statusGroupId":"00000000-0000-0000-0000-000000000000"}'

Response · 200 · Folder

idstring · uuid*
workspaceIdstring · uuid*
parentIdstring · uuid | null*
namestring*
pathstring*
positionstring*
statusGroupIdstring · uuid | null*
effectiveStatusGroupIdstring · uuid*
tagGroupIds(string · uuid)[]*
effectiveTagGroupIds(string · uuid)[] | null*
privateboolean*
protectedboolean*
effectiveProtectedboolean*
glyphstring | null*
createdAtstring*

Also answers 401 and 403. SeeErrors.

put/api/folders/{id}/tag-groups#

tickets:write

Path

idstring*

Body

tagGroupIds(string · uuid)[]*
Request
curl https://api.shairelabs.com/api/folders/$FOLDER_ID/tag-groups \
  -X PUT \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tagGroupIds":[]}'

Response · 200 · Folder

idstring · uuid*
workspaceIdstring · uuid*
parentIdstring · uuid | null*
namestring*
pathstring*
positionstring*
statusGroupIdstring · uuid | null*
effectiveStatusGroupIdstring · uuid*
tagGroupIds(string · uuid)[]*
effectiveTagGroupIds(string · uuid)[] | null*
privateboolean*
protectedboolean*
effectiveProtectedboolean*
glyphstring | null*
createdAtstring*

Also answers 401 and 403. SeeErrors.