Skip to main content

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.

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.
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.

List Hubs

Retrieve all hubs in your organization

Create Hub

Create a new hub location

Team Management

Teams allow you to group users within a hub for better organization and task assignment.

App Integration

Manage API integrations and third-party connections for your organization.

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:
  • Task - Manage tasks within hubs
  • Routing - Create routes starting from hubs
  • Flow - Configure task templates