DEV API Reference
Complete API documentation for DEV - Developers & Integration tools.
Quick Start
Authentication
Choose authentication based on your use case:
User-Connected Apps (De.auth):
http
de-auth-token: YOUR_AUTH_TOKEN
de-user-agent: YOUR_USER_AGENT
de-auth-device: YOUR_DEVICE_IDServer-to-Server / Connectors:
http
Authorization: Bearer <ACCESS_TOKEN>Base URL
https://api.dedot.io/v1/devAPI Categories
Invitation
3 endpoints available
- POST Invite user to Developer workspace -
/v1/devs/:xcode/invitation/:as - DELETE Cancel invitation -
/v1/devs/:xcode/invitation - POST Accept invitation -
/v1/devs/:xcode/invitation/accept
Operators
4 endpoints available
- GET Get Operator Information -
/v1/devs/:xcode/operators/:id - GET Get All Operators -
/v1/devs/:xcode/operators - PATCH Update Operator Information -
/v1/devs/:xcode/operators/:id - DELETE Remove Operator Access -
/v1/devs/:xcode/operators/:id
Developers
4 endpoints available
- GET Get a Developer Information -
/v1/devs/:xcode/developers/:id - GET Get All Developers -
/v1/devs/:xcode/developers - PATCH Update Developer Information -
/v1/devs/:xcode/developers/:id - DELETE Remove Developer Access from DEV -
/v1/devs/:xcode/developers/:id
FAQs
10 endpoints available
- POST Add FAQ -
/v1/lsps/:icode/faqs - GET Retrieve FAQ -
/v1/lsps/:icode/faqs/:reference - GET Fetch FAQs -
/v1/lsps/:icode/faqs - GET Search FAQ -
/v1/lsps/:icode/faqs/search?query=delivery - PATCH Update FAQ -
/v1/lsps/:icode/faqs/:reference
Response Format
All API responses follow this structure:
typescript
interface APIResponse<T> {
error: boolean;
status: string;
message?: string;
data?: T;
}Success Response
json
{
"error": false,
"status": "SUCCESS",
"data": { ... }
}Error Response
json
{
"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:
http
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:
http
GET /v1/dev/resource?page=1&limit=50Response includes pagination metadata:
json
{
"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.

