Workspaces & Teams

Manage workspaces, invite team members, and control access with roles.

Overview

Workspaces are the top-level organizational unit in Encrata. Each workspace has its own:

• API keys and usage quotas
• Team members with role-based access
• Monitors, workflows, and contact lists
• Billing and credit balance

---

Workspace Management

List Workspaces

GET /api/workspaces

Returns all workspaces the authenticated user belongs to.

---

Create Workspace

POST /api/workspaces

Field	Type	Required	Description
name	string	Yes	Workspace display name
slug	string	No	URL-friendly identifier (auto-generated if omitted)

---

Update Workspace

PUT /api/workspaces

Field	Type	Description
name	string	New workspace name
slug	string	New slug
logo	string	Logo URL

---

Delete Workspace

DELETE /api/workspaces

This permanently deletes the workspace and all its data. Requires OTP verification.

---

Switch Workspace

POST /api/workspaces/switch

Field	Type	Required	Description
workspace_id	string	Yes	ID of the workspace to switch to

---

Team Members

List Members

GET /api/workspaces/members

Returns all members of the current workspace with their roles.

Response:

[
  {
    "id": "user_abc",
    "email": "[e-mail]",
    "name": "Alice",
    "role": "admin",
    "joined_at": "2026-01-15T10:00:00Z"
  }
]

---

Invite Member

POST /api/workspaces/members

Field	Type	Required	Description
email	string	Yes	Email address to invite
role	string	Yes	Role: admin, member, or readonly

The invited user receives an email with a link to accept the invitation.

---

Update Member Role

PUT /api/workspaces/members

Field	Type	Required	Description
user_id	string	Yes	User ID to update
role	string	Yes	New role: admin, member, or readonly

---

Remove Member

DELETE /api/workspaces/members

Field	Type	Required	Description
user_id	string	Yes	User ID to remove

---

Leave Workspace

POST /api/workspaces/leave

Leave the current workspace. Requires OTP verification. Cannot leave if you’re the only admin.

---

Accept Invite

POST /api/workspaces/accept

Public endpoint — accepts a workspace invitation using the token from the invite email.

Field	Type	Required	Description
token	string	Yes	Invitation token from email

---

Roles

Role	Permissions
admin	Full access — manage members, billing, SSO, workspace settings
member	Use all features — lookups, workflows, monitors, API keys
readonly	View-only access — cannot create or modify resources

---

SSO (Single Sign-On)

Enterprise workspaces can configure SSO for seamless team authentication.

List SSO Connections

GET /api/sso/connections

Create SSO Connection

POST /api/sso/connections

Field	Type	Required	Description
provider	string	Yes	SSO provider: saml, oidc
name	string	Yes	Display name
domain	string	Yes	Email domain to match
config	object	Yes	Provider-specific configuration

Update SSO Connection

PUT /api/sso/connections

Delete SSO Connection

DELETE /api/sso/connections

Test SSO Connection

POST /api/sso/test

Validates the SSO configuration by attempting a test authentication flow.