Skip to main content

Documentation Index

Fetch the complete documentation index at: https://montereyfinancial.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Workspaces are the top-level organizational unit in Monterey. Every resource (templates, campaigns, assets, merge fields) is scoped to a workspace, ensuring complete tenant isolation.

​
Workspace scoping

All API requests (except GET /auth/me) require a workspace_id header. The API validates that the authenticated user has a membership in the target workspace before processing any request. 
curl -H "Authorization: Bearer <token>" \
     -H "workspace_id: 550e8400-e29b-41d4-a716-446655440000" \
     http://localhost:8000/email-campaigns/

​
Managing workspaces

Workspace CRUD operations are restricted to platform admins.
OperationEndpointRole required
ListGET /workspaces/Platform admin sees all; others see their memberships
GetGET /workspaces/{id}Platform admin
CreatePOST /workspaces/Platform admin
UpdatePUT /workspaces/{id}Platform admin
DeleteDELETE /workspaces/{id}Platform admin

​
Memberships

Workspace memberships control who can access a workspace and at what role level.
OperationEndpoint
List membersGET /workspace-memberships/
Search candidatesGET /workspace-memberships/candidates
Add memberPOST /workspace-memberships/
Update rolePUT /workspace-memberships/{id}
Remove memberDELETE /workspace-memberships/{id}
The candidates endpoint lets you search for users who can be invited to a workspace by email.