Session
Sessions are timed focus blocks that users create, join, and complete. They support scheduling, recurrence, website blocking, and notification snoozing.
Base URL:
https://api.deepworkzone.aiAuth:Authorization: Bearer YOUR_MULTIPLAI_ACCESS_TOKEN
Session Ownership
The created_by field and session ownership are automatically derived from the currently authenticated user resolved from the Multiplai access token. You do not need to pass an owner or creator field when creating sessions.
List Sessions
GET /api/v1/sessionsReturns a list of sessions for the authenticated user's organization, filtered by the provided query parameters.
| Parameter | Type | Description |
|---|---|---|
org_id | number | Organization ID to scope the results |
channel | string | Filter by visibility: public or private |
type | string | Filter by type: drop-in or standard |
date | string | Filter by date (YYYY-MM-DD) |
completed | 0|1 | Filter completed sessions (0 = active, 1 = done) |
source | string | Scope: user or organization |
keyword | string | Search by session name |
day_start | string | Start of date range filter |
day_ends | string | End of date range filter |
Get Session
GET /api/v1/sessions/:idRetrieves a single session by its ID, along with the authenticated user's participation metadata.
| Parameter | Type | Description |
|---|---|---|
id | number | The session ID |
Create Session
POST /api/v1/sessionsCreates a new focus session.
{
"org_id": 1,
"name": "Morning Deep Work",
"type": "drop-in",
"duration": 60,
"schedule": "2025-01-01",
"time": "9:00 AM",
"is_public": true,
"collaborator": [],
"status": "waiting",
"website_blocker_enabled": true,
"website_blocker": {
"mode": "preset",
"category": ["social-media", "gaming"],
"urls": []
},
"snooze_enabled": true,
"snooze_apps": {
"slack": true,
"teams": true
},
"is_recurring": 0,
"recurring_ends": null,
"recurring_start": null,
"occurrence": "daily",
"recurring_days": [],
"recurring_month_option": "exact",
"recurring_month_week_pos": 1,
"recurring_month_week_day": 1,
"fallback_option": 0
}Update Session
PUT /api/v1/sessions/:idUpdates an existing session. Accepts the same fields as Create Session.
| Parameter | Type | Description |
|---|---|---|
id | number | The session ID |
Delete Session
DELETE /api/v1/sessions/:idDeletes a session. For recurring sessions, you can choose to delete only the current occurrence or the entire series.
| Parameter | Type | Description |
|---|---|---|
id | number | The session ID |