Skip to main content

Workspace API

Retrieve and update workspace details, and list team members.

Get Workspace

curl https://www.zevform.com/api/v1/workspace \
  -H "Authorization: Bearer zev_your_api_key"

Response

{
  "data": {
    "id": "ws_abc123",
    "name": "My Company",
    "slug": "my-company",
    "icon": null,
    "created_at": "2026-01-15T10:00:00Z",
    "member_count": 5,
    "form_count": 12
  }
}

Update Workspace

curl -X PATCH https://www.zevform.com/api/v1/workspace \
  -H "Authorization: Bearer zev_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Workspace Name",
    "slug": "new-slug"
  }'

Parameters

ParameterTypeDescription
namestringDisplay name for the workspace
slugstringURL slug (lowercase, alphanumeric, hyphens). Must be unique.

Response

{
  "data": {
    "id": "ws_abc123",
    "name": "New Workspace Name",
    "slug": "new-slug",
    "icon": null,
    "created_at": "2026-01-15T10:00:00Z"
  }
}

Members

List Members

curl https://www.zevform.com/api/v1/workspace/members \
  -H "Authorization: Bearer zev_your_api_key"

Response

{
  "data": [
    {
      "id": "mem_001",
      "user_id": "user_abc",
      "role": "owner",
      "joined_at": "2026-01-15T10:00:00Z",
      "profile": {
        "email": "owner@example.com",
        "full_name": "Jane Doe",
        "avatar_url": "https://..."
      }
    },
    {
      "id": "mem_002",
      "user_id": "user_def",
      "role": "member",
      "joined_at": "2026-02-20T14:00:00Z",
      "profile": {
        "email": "member@example.com",
        "full_name": "John Smith",
        "avatar_url": null
      }
    }
  ]
}

Member Roles

RoleDescription
ownerFull access including billing and workspace deletion
adminManage forms, members, and integrations
memberCreate and edit forms, view responses