List add-ons
curl --request GET \
--url https://apiweb.mile.app/api/v3/addons \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiweb.mile.app/api/v3/addons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apiweb.mile.app/api/v3/addons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiweb.mile.app/api/v3/addons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiweb.mile.app/api/v3/addons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiweb.mile.app/api/v3/addons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/addons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success.",
"data": {
"current_page": 1,
"data": [
{
"id": "68b440c9dad4c5d45707f6d2",
"name": "Custom Dashboard Widget",
"description": "A custom widget for displaying real-time analytics data",
"resourceFile": "1756656087_Custom-Dashboard-Widget.js",
"icon": "https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg",
"organizationId": "686cc0ff083ca8093204f002",
"resourceUrl": "https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js",
"createdBy": "[email protected]",
"updatedBy": "[email protected]",
"createdTime": "2025-08-31T10:30:00.000000Z",
"updatedTime": "2025-08-31T10:35:00.000000Z",
"organizationName": "Acme Logistics",
"isUsed": false,
"isPublished": true,
"customModuleId": null,
"status": "active"
}
],
"first_page_url": "https://api.mile.app/api/v3/addons?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://api.mile.app/api/v3/addons?page=1",
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"next_page_url": null,
"path": "https://api.mile.app/api/v3/addons",
"per_page": 10,
"prev_page_url": null,
"to": 2,
"total": 2
}
}{
"status": true,
"message": "<string>",
"failedCode": "<string>"
}{
"status": true,
"message": "<string>",
"failedCode": "<string>"
}{
"status": true,
"message": "<string>",
"failedCode": "<string>"
}Add-ons
List add-ons
Retrieves a paginated list of add-ons accessible to your organization, including both organization-specific add-ons and global system add-ons. Supports search, filtering, and sorting with Laravel pagination.
GET
/
addons
List add-ons
curl --request GET \
--url https://apiweb.mile.app/api/v3/addons \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiweb.mile.app/api/v3/addons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apiweb.mile.app/api/v3/addons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiweb.mile.app/api/v3/addons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiweb.mile.app/api/v3/addons"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiweb.mile.app/api/v3/addons")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/addons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Success.",
"data": {
"current_page": 1,
"data": [
{
"id": "68b440c9dad4c5d45707f6d2",
"name": "Custom Dashboard Widget",
"description": "A custom widget for displaying real-time analytics data",
"resourceFile": "1756656087_Custom-Dashboard-Widget.js",
"icon": "https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg",
"organizationId": "686cc0ff083ca8093204f002",
"resourceUrl": "https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js",
"createdBy": "[email protected]",
"updatedBy": "[email protected]",
"createdTime": "2025-08-31T10:30:00.000000Z",
"updatedTime": "2025-08-31T10:35:00.000000Z",
"organizationName": "Acme Logistics",
"isUsed": false,
"isPublished": true,
"customModuleId": null,
"status": "active"
}
],
"first_page_url": "https://api.mile.app/api/v3/addons?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://api.mile.app/api/v3/addons?page=1",
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"next_page_url": null,
"path": "https://api.mile.app/api/v3/addons",
"per_page": 10,
"prev_page_url": null,
"to": 2,
"total": 2
}
}{
"status": true,
"message": "<string>",
"failedCode": "<string>"
}{
"status": true,
"message": "<string>",
"failedCode": "<string>"
}{
"status": true,
"message": "<string>",
"failedCode": "<string>"
}Authorizations
Use a valid Bearer token to authenticate.
Query Parameters
Search query to filter add-ons by name or description
Maximum string length:
255Field to sort by
Available options:
name, createdTime, updatedTime, usageCount Sort order (ascending or descending)
Available options:
asc, desc Page number for pagination
Required range:
1 <= x <= 1000Number of items per page (maximum 100)
Required range:
1 <= x <= 100Filter by add-on status
Available options:
active, inactive, draft