Overview
The Setting API provides endpoints to manage your organization’s configuration, including users, roles, permissions, hubs, teams, and third-party integrations. These settings control access, structure, and behavior of your MileApp organization.API Categories
User Management
Manage users within your organization including creating, updating, inviting, and deactivating users.| Endpoint | Description |
|---|---|
GET /users | List all users |
GET /user/{userId} | Get user details |
POST /user | Create a new user |
PUT /user/{userId} | Update user information |
DELETE /user/{userId} | Delete a user |
POST /user/invite | Invite a new user |
List Users
Retrieve all users in your organization
Invite User
Invite a new user to join your organization
Role Management
Define and manage roles that control user permissions across your organization.| Endpoint | Description |
|---|---|
GET /roles | List all roles |
GET /role/{roleId} | Get role details |
POST /role | Create a new role |
PUT /role/{roleId} | Update role permissions |
DELETE /role/{roleId} | Delete a role |
Roles define what actions users can perform. Each role has a set of permissions that control access to features and data.
Hub Management
Hubs represent physical locations or warehouses in your organization. They serve as starting points for routes and task assignments.| Attribute | Description |
|---|---|
_id | Unique hub identifier |
name | Hub name |
address | Physical address |
lat | Latitude coordinate |
lng | Longitude coordinate |
organizationId | Parent organization |
Team Management
Teams allow you to group users within a hub for better organization and task assignment.| Endpoint | Description |
|---|---|
GET /teams | List all teams |
GET /team/{teamId} | Get team details |
POST /team | Create a new team |
PUT /team/{teamId} | Update team |
DELETE /team/{teamId} | Delete a team |
App Integration
Manage API integrations and third-party connections for your organization.| Endpoint | Description |
|---|---|
GET /app-integrations | List all integrations |
POST /app-integration | Create new integration |
PUT /app-integration/{id} | Update integration |
DELETE /app-integration/{id} | Delete integration |
Plugin Settings
Configure plugins and extensions for your organization.Common Operations
User Management
Manage organization users
Role Management
Configure roles and permissions
Hub Management
Manage hub locations
Team Management
Organize users into teams
Permissions
Most Setting API endpoints require specific permissions:| Resource | Required Permission |
|---|---|
| Users | View User, Edit User |
| Roles | View Role, Edit Role |
| Hubs | View Hub, Edit Hub |
| Teams | View Team, Edit Team |