WORKSPACE API Reference
Complete API documentation for Business Workspace.
Quick Start
Authentication
Business workspace endpoints require De. authentication headers:
de-auth-token: YOUR_AUTH_TOKEN
de-user-agent: YOUR_USER_AGENT
de-auth-device: YOUR_DEVICE_IDBase URL
https://api.dedot.io/v1/workspaceAPI Categories
Workspace
4 endpoints available
- POST Setup workspace -
/v1/workspace/setup - GET Get a workspace -
/v1/workspace/:wid - PATCH Update a workspace -
/v1/workspace/:wid - DELETE Delete a workspace -
/v1/workspace/:wid
Account
2 endpoints available
- GET Retreive User Account -
/v1/:wid/account - GET Check User Account from external service -
/v1/:wid/account/knows
Invitation
3 endpoints available
- POST Invite an admin into the workspace -
/v1/:wid/invitation/admin - DELETE Cancel invitation -
/v1/:wid/invitation - POST Accept invitation -
/v1/:wid/invitation/accept
Users
3 endpoints available
- GET Fetch all LSP Users -
/v1/:wid/users - GET Retreive LSP user account -
/v1/:wid/users/:uid - DELETE Remove LSP User -
/v1/:wid/users/:uid
Admins
4 endpoints available
- GET Get Admin info -
/v1/:wid/admins/:id - GET Get All Admins -
/v1/:wid/admins - PATCH Update Admin Info -
/v1/:wid/admins/:id - DELETE Remove Admin Access -
/v1/:wid/admins/:id
DEV Services
6 endpoints available
- POST Setup a DEV -
/v1/:wid/dev/setup - GET Get a DEV -
/v1/:wid/dev/:xcode - GET Get all DEVs -
/v1/:wid/devs - GET Request DEV Context -
/v1/:wid/dev/:xcode/context - PATCH Update a DEV -
/v1/:wid/dev/:xcode
→ View all DEV Services endpoints
CSP Services
6 endpoints available
- POST Setup a CSP -
/v1/:wid/csp/setup - GET Get a CSP -
/v1/:wid/csp/:xcode - GET Get All CSPs -
/v1/:wid/csps - GET Request CSP Context -
/v1/:wid/csp/:xcode/context - PATCH Update a CSP -
/v1/:wid/csp/:xcode
→ View all CSP Services endpoints
IoTSP Services
6 endpoints available
- POST Setup an IoTSP -
/v1/:wid/iotsp/setup - GET Get an IoTSP -
/v1/:wid/iotsp/:xcode - GET Get All IoTSPs -
/v1/:wid/iotsps - GET Request IoTSP Context -
/v1/:wid/iotsp/:xcode/context - PATCH Update an IoTSP -
/v1/:wid/iotsp/:xcode
→ View all IoTSP Services endpoints
LSP Services
6 endpoints available
- POST Setup a LSP -
/v1/:wid/lsp/setup - GET Get a LSP -
/v1/:wid/lsp/:xcode - GET Get All LSPs -
/v1/:wid/lsps - GET Request LSP Context -
/v1/:wid/lsp/:xcode/context - PATCH Update a LSP -
/v1/:wid/lsp/:xcode
→ View all LSP Services endpoints
Connectors
10 endpoints available
- POST Create Connector -
/v1/:wid/:ctype/:xcode/connectors - GET Retreive Connector Information -
/v1/:wid/:ctype/:xcode/connectors/:id - GET Get All Connectors -
/v1/:wid/:ctype/:xcode/connectors - PATCH Update Connector Information -
/v1/:wid/:ctype/:xcode/connectors/:id - PATCH Enable/Disabled Connector -
/v1/:wid/:ctype/:xcode/connectors/:id/:action
→ View all Connectors endpoints
Access
4 endpoints available
- POST Generate access token -
/v1/access/token - PATCH Rotate access token -
/v1/access/token/rotate - PATCH Revoke access token -
/v1/access/token/revoke - GET Get defined access configuration -
/v1/access/config?expects=ASI
Integrations
21 endpoints available
- POST Search agents arround -
/v1/client/:id/periferals - GET Get orders -
/v1/client/:id/orders/:type - POST Get order intent token -
/v1/order/intent - DELETE Cancel order intent -
/v1/order/intent/cancel - GET Get order operators information -
/v1/order/operators
→ View all Integrations endpoints
Response Format
All API responses follow this structure:
interface APIResponse<T> {
error: boolean;
status: string;
message?: string;
data?: T;
}Success Response
{
"error": false,
"status": "SUCCESS",
"data": { ... }
}Error Response
{
"error": true,
"status": "ERROR_CODE",
"message": "Human-readable error message"
}Common Error Codes
| Status Code | Description |
|---|---|
SUCCESS | Request completed successfully |
NOT_FOUND | Resource not found (404) |
UNAUTHORIZED | Authentication failed (401) |
FORBIDDEN | Insufficient permissions (403) |
VALIDATION_ERROR | Invalid request data (400) |
INTERNAL_ERROR | Server error (500) |
Rate Limits
Standard Rate Limits:
- 1000 requests per hour
- 100 requests per minute (burst)
Rate limit headers:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200When rate limit is exceeded, you'll receive a 429 Too Many Requests response.
Pagination
List endpoints support pagination:
GET /v1/workspace/resource?page=1&limit=50Response includes pagination metadata:
{
"error": false,
"status": "SUCCESS",
"data": [...],
"pagination": {
"page": 1,
"limit": 50,
"total": 237,
"pages": 5
}
}Helpful Resources
Need help? Check our Developer Portal or contact support.

