Skip to main content

Content settings

Workspace configuration for tags, taxonomy, teams, roles, custom fields, and email templates.

All routes are workspace-scoped:

/api/v1/{workspace_id}/…

Tags​

GET /api/v1/{workspace_id}/tags/
POST /api/v1/{workspace_id}/tags/
GET /api/v1/{workspace_id}/tags/{tag_id}/
PUT /api/v1/{workspace_id}/tags/{tag_id}/
PATCH /api/v1/{workspace_id}/tags/{tag_id}/
DELETE /api/v1/{workspace_id}/tags/{tag_id}/

Categories​

GET /api/v1/{workspace_id}/categories/
POST /api/v1/{workspace_id}/categories/
GET /api/v1/{workspace_id}/categories/{category_id}/
PUT /api/v1/{workspace_id}/categories/{category_id}/
PATCH /api/v1/{workspace_id}/categories/{category_id}/
DELETE /api/v1/{workspace_id}/categories/{category_id}/

Event types & sub-types​

GET /api/v1/{workspace_id}/types/
POST /api/v1/{workspace_id}/types/
GET /api/v1/{workspace_id}/types/{type_id}/
PUT /api/v1/{workspace_id}/types/{type_id}/
PATCH /api/v1/{workspace_id}/types/{type_id}/
DELETE /api/v1/{workspace_id}/types/{type_id}/

GET /api/v1/{workspace_id}/types/subtypes/
POST /api/v1/{workspace_id}/types/subtypes/
GET /api/v1/{workspace_id}/types/subtypes/{subtype_id}/
PUT /api/v1/{workspace_id}/types/subtypes/{subtype_id}/
PATCH /api/v1/{workspace_id}/types/subtypes/{subtype_id}/
DELETE /api/v1/{workspace_id}/types/subtypes/{subtype_id}/

Teams (sub-teams)​

GET /api/v1/{workspace_id}/teams/
POST /api/v1/{workspace_id}/teams/
GET /api/v1/{workspace_id}/teams/{team_id}/
PUT /api/v1/{workspace_id}/teams/{team_id}/
PATCH /api/v1/{workspace_id}/teams/{team_id}/
DELETE /api/v1/{workspace_id}/teams/{team_id}/

Roles & permissions​

GET /api/v1/{workspace_id}/roles/
POST /api/v1/{workspace_id}/roles/
GET /api/v1/{workspace_id}/roles/{role_id}/
PUT /api/v1/{workspace_id}/roles/{role_id}/
PATCH /api/v1/{workspace_id}/roles/{role_id}/
DELETE /api/v1/{workspace_id}/roles/{role_id}/
GET /api/v1/{workspace_id}/roles/permissions-template/
PATCH /api/v1/{workspace_id}/roles/{role_id}/permissions/
POST /api/v1/{workspace_id}/roles/backfill-defaults/

PATCH …/permissions/ and POST …/backfill-defaults/ require admin.

Permission keys match MODULE_PERMISSIONS.md in the repo.

Custom fields​

GET /api/v1/{workspace_id}/custom-fields/
POST /api/v1/{workspace_id}/custom-fields/
GET /api/v1/{workspace_id}/custom-fields/{field_id}/
PUT /api/v1/{workspace_id}/custom-fields/{field_id}/
PATCH /api/v1/{workspace_id}/custom-fields/{field_id}/
DELETE /api/v1/{workspace_id}/custom-fields/{field_id}/

Email templates​

GET /api/v1/{workspace_id}/email-templates/
POST /api/v1/{workspace_id}/email-templates/
GET /api/v1/{workspace_id}/email-templates/{template_id}/
PUT /api/v1/{workspace_id}/email-templates/{template_id}/
PATCH /api/v1/{workspace_id}/email-templates/{template_id}/
DELETE /api/v1/{workspace_id}/email-templates/{template_id}/