# Derive Workspace API

**Canonical:** https://apis.io/apis/derive-to/derive-to-workspace-api/  
**Provider:** Derive — https://apis.io/providers/derive-to/  
**Documentation:** https://docs.derive.to/reference/api/

Derive Workspace API is one of 28 APIs that [Derive](https://apis.io/providers/derive-to/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Workspace. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The workspace itself: members, settings, invitations, and switching.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/workspace` | The active workspace: name, the caller's role, and the member directory |
| PATCH | `/v1/workspace` | Rename the workspace (Admin only) |
| PUT | `/v1/workspace/members` | Add a member (by @handle or email) or change their role (Admin only) |
| PATCH | `/v1/workspace/members/{userId}` | Change a member's role (Admin only; keeps at least one admin) |
| DELETE | `/v1/workspace/members/{userId}` | Remove a member (Admin only; keeps at least one admin) |
| POST | `/v1/workspace/invites` | Invite by email — adds an existing account directly, else a pending invite |
| GET | `/v1/workspace/invites` | Pending invitations for the workspace (Admin only) |
| POST | `/v1/workspace/invites/{id}/resend` | Rotate a pending invitation and return its acceptance link (Admin only) |
| DELETE | `/v1/workspace/invites/{id}` | Revoke a pending invitation (Admin only) |
| GET | `/v1/invites/{token}` | Preview an invitation (the accept page reads this) |
| POST | `/v1/invites/{token}/accept` | Accept an invitation (the signed-in token holder joins) |
| GET | `/v1/workspace/settings` | The workspace's integration toggles (any member) |
| PATCH | `/v1/workspace/settings` | Update the workspace's integration toggles (Admin only) |
| GET | `/v1/workspaces` | The caller's workspaces + which one this request resolved to |
| POST | `/v1/workspaces` | Create a workspace (the creator becomes its Admin and is switched in) |
| POST | `/v1/workspace/switch` | Switch the active workspace (must be a member) |
| DELETE | `/v1/workspaces/{id}` | Delete an empty workspace you own (switches away if it was active) |
| GET | `/v1/workspace/join-link` | The workspace's join link (Admin only); 404 when none exists |
| POST | `/v1/workspace/join-link` | Create the workspace's join link, or rotate it (Admin only) |
| DELETE | `/v1/workspace/join-link` | Revoke the workspace's join link (Admin only) |
| GET | `/v1/join/{token}` | Preview a join link (the join page reads this) |
| POST | `/v1/join/{token}` | Join the workspace through its link (signed-in holder) |
| GET | `/v1/workspace/activity` | Recent activity across the workspace, for the home |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/derive-to/openapi/derive-to-workspace-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/derive-to/json-schema/derive-to-artifact-schema.json
- **JSONSchema** — https://artifacts.apis.io/derive-to/json-schema/derive-to-job-schema.json
- **JSONSchema** — https://artifacts.apis.io/derive-to/json-schema/derive-to-context-analysis-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/derive-to/json-schema/derive-to-agent-schema.json
- **JSONSchema** — https://artifacts.apis.io/derive-to/json-schema/derive-to-comment-schema.json
- **JSONSchema** — https://artifacts.apis.io/derive-to/json-schema/derive-to-collection-schema.json

## Other Derive APIs (12)

- [Derive Accounts API](https://apis.io/apis/derive-to/derive-to-accounts-api/)
- [Derive Activity API](https://apis.io/apis/derive-to/derive-to-activity-api/)
- [Derive Agents API](https://apis.io/apis/derive-to/derive-to-agents-api/)
- [Derive Analytics API](https://apis.io/apis/derive-to/derive-to-analytics-api/)
- [Derive Artifacts API](https://apis.io/apis/derive-to/derive-to-artifacts-api/)
- [Derive Assets API](https://apis.io/apis/derive-to/derive-to-assets-api/)
- [Derive Collections API](https://apis.io/apis/derive-to/derive-to-collections-api/)
- [Derive Comments API](https://apis.io/apis/derive-to/derive-to-comments-api/)
- [Derive Contexts API](https://apis.io/apis/derive-to/derive-to-contexts-api/)
- [Derive Domains API](https://apis.io/apis/derive-to/derive-to-domains-api/)
- [Derive Exports API](https://apis.io/apis/derive-to/derive-to-exports-api/)
- [Derive Favorites API](https://apis.io/apis/derive-to/derive-to-favorites-api/)

## Tags

Workspace

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/derive-to/derive-to-workspace-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/derive-to/.