Skip to main content

Organization API

Organization APIs provide taxonomy and access structure for links.

Endpoint matrix

Tags

MethodPathPurpose
GET/tagsList tags
POST/tagsCreate tag
PATCH/tags/:idUpdate tag
DELETE/tags/:idDelete tag
GET/tags/:id/linksList links assigned to tag

Folders

MethodPathPurpose
GET/foldersList folders
POST/foldersCreate folder
PATCH/folders/:idUpdate folder
DELETE/folders/:idDelete folder
GET/folders/:id/usersList folder users/roles
POST/folders/:id/usersAdd folder user
PATCH/folders/:id/users/:userIdUpdate folder user role
DELETE/folders/:id/users/:userIdRemove folder user
POST/folders/:id/access-requestsSubmit access request
GET/folders/:id/access-requestsList pending requests
POST/folders/:id/access-requests/:requestId/approveApprove request
POST/folders/:id/access-requests/:requestId/rejectReject request

UTM templates

MethodPathPurpose
GET/utm-templatesList templates
POST/utm-templatesCreate template
PATCH/utm-templates/:idUpdate template
DELETE/utm-templates/:idDelete template

Key behavior notes

  • Tag names are unique per workspace.
  • Folder parent validation prevents invalid self-parent structures.
  • Deleting a folder automatically detaches links from that folder (folderId becomes null).
  • Folder role updates/removals are owner-gated at folder level.
  • UTM templates are stored as reusable parameter presets.

Permission model

  • Reads require links:read.
  • Creates typically require links:create.
  • Mutations generally require links:update/links:delete.
  • Folder user/admin operations require both workspace permission and folder-level access checks.

Plan limit gates

  • tag count
  • folder count
  • UTM template count
When over limit, create endpoints return limit errors until resources are reduced or plan is upgraded.

Typical failures

  • 404 NOT_FOUND: folder/tag/template missing
  • 409 CONFLICT: duplicate tag name or duplicate access request
  • 403 FORBIDDEN: insufficient folder-level permission
  • 400 BAD_REQUEST: invalid parent/self-folder assignment
Related docs:
  • /user-guides/manual/growth/tags-folders-utm-reference
  • /user-guides/manual/workspace/workspaces-and-access