Skip to main content

​
Overview

Team Workspaces

Create separate workspaces for different projects or teams

Member Management

Invite team members with different role permissions

Isolated Settings

Each workspace has its own domains, keys, and configuration

Role-Based Access

Owner, admin, and member roles with different permissions

​
List Workspaces

GET/v1/workspaces
Retrieve all workspaces the authenticated user belongs to. 
curl https://www.unosend.co/api/v1/workspaces \
  -H "Authorization: Bearer un_your_api_key"

​
Response

200 OK
{
  "data": [
    {
      "id": "org_550e8400-e29b-41d4-a716",
      "name": "Acme Corp",
      "slug": "acme-corp-abc123",
      "icon_url": "https://storage.unosend.co/icons/acme.png",
      "owner_id": "user_123",
      "role": "owner",
      "created_at": "2024-01-01T00:00:00.000Z"
    },
    {
      "id": "org_660e8400-e29b-41d4-a717",
      "name": "Side Project",
      "slug": "side-project-xyz789",
      "icon_url": null,
      "owner_id": "user_456",
      "role": "member",
      "created_at": "2024-02-15T00:00:00.000Z"
    }
  ]
}

​
Create Workspace

POST/v1/workspaces
Create a new workspace. The authenticated user becomes the owner.

​
Request Body

​
name
string
required
Workspace name (max 100 characters)
​
icon_url
string
URL of workspace icon (optional)
curl -X POST https://www.unosend.co/api/v1/workspaces \
  -H "Authorization: Bearer un_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Project"
  }'

​
Response

201 Created
{
  "data": {
    "id": "org_770e8400-e29b-41d4-a718",
    "name": "New Project",
    "slug": "new-project-def456",
    "icon_url": null,
    "owner_id": "user_123",
    "role": "owner",
    "created_at": "2024-03-01T00:00:00.000Z"
  }
}

​
Get Workspace

GET/v1/workspaces/:id
Retrieve details for a specific workspace. 
curl https://www.unosend.co/api/v1/workspaces/org_550e8400-e29b-41d4-a716 \
  -H "Authorization: Bearer un_your_api_key"

​
Response

200 OK
{
  "data": {
    "id": "org_550e8400-e29b-41d4-a716",
    "name": "Acme Corp",
    "slug": "acme-corp-abc123",
    "icon_url": "https://storage.unosend.co/icons/acme.png",
    "owner_id": "user_123",
    "role": "owner",
    "created_at": "2024-01-01T00:00:00.000Z",
    "member_count": 5
  }
}

​
Update Workspace

PATCH/v1/workspaces/:id
Update workspace settings. Requires owner or admin role. 
curl -X PATCH https://www.unosend.co/api/v1/workspaces/org_550e8400-e29b-41d4-a716 \
  -H "Authorization: Bearer un_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation"
  }'

​
Delete Workspace

DELETE/v1/workspaces/:id
Permanently delete a workspace and all its data. Requires owner role.
This action is irreversible. All domains, API keys, emails, and associated data will be permanently deleted.
curl -X DELETE https://www.unosend.co/api/v1/workspaces/org_550e8400-e29b-41d4-a716 \
  -H "Authorization: Bearer un_your_api_key"

​
Workspace Roles

RolePermissions
ownerFull access including billing, deletion, and ownership transfer
adminManage domains, API keys, members, and settings (no billing/deletion)
memberSend emails, view logs, access dashboard (read-only settings)
Each workspace must have exactly one owner. To transfer ownership, use the dashboard or contact support.