Workspace API

The Workspace API allows you to access and manage workspace-level information in DMLY.
Use it to list available workspaces and fetch a workspace’s details by ID.

VIDEO GUIDE:

🔗 Base URL

https://api.dmly.io/rest

🔐 Authentication

All endpoints require the x-api-key header:

x-api-key: YOUR_API_KEY

📌 Endpoints

1⃣ List Workspaces

GET /v1/workspaces

Retrieve a list of workspaces.

Response: 200 OK — Array of Workspace

🔎 Query Parameters

📥 Example Request

curl -X GET "https://api.dmly.io/rest/v1/workspaces?page=1&limit=20&searchText=marketing" \
  -H "x-api-key: YOUR_API_KEY"

✅ Example Response

[
  {
    "id": "ws_001",
    "title": "Marketing Team"
  },
  {
    "id": "ws_002",
    "title": "Sales Workspace"
  }
]

2⃣ Get Workspace by ID

GET /v1/workspaces/{workspaceId}

Retrieve a workspace by its unique ID.

Response: 200 OK — Workspace

🔎 Path Parameters

📥 Example Request

curl -X GET "https://api.dmly.io/rest/v1/workspaces/ws_001" \
  -H "x-api-key: YOUR_API_KEY"

✅ Example Response

{
  "id": "ws_001",
  "title": "Marketing Team"
}

📦 Schemas

Workspace Schema

{
  "id": "string",
  "title": "string"
}

Workspaces Schema

[
  {
    // Workspace object
  }
]

✅ Best Practices

• Use searchText to support workspace pickers in your UI.

• Paginate large results using page and limit.

• Cache workspace lists server-side if your integration requests them frequently.

• Store workspaceId and reuse it when calling Contacts, Messages, Broadcasts, Templates, and Segments endpoints.

🔐 Security Notes

• Never expose x-api-key in browser/frontend applications.

• Restrict API key usage to server-side services.

• Ensure the caller is authorized to access the requested workspace (especially in multi-tenant integrations).