List add-ons/plugins

curl --request GET \
  --url https://apiweb.mile.app/api/v3/plugins \
  --header 'Authorization: Bearer <token>'

{
  "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": "user@mile.app",
        "updatedBy": "user@mile.app",
        "createdTime": "2025-08-31T10:30:00.000000Z",
        "updatedTime": "2025-08-31T10:35:00.000000Z",
        "organizationName": "MileApp",
        "isUsed": false,
        "customModuleId": null,
        "status": "active"
      }
    ],
    "first_page_url": "https://api.mile.app/api/v3/plugins?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.mile.app/api/v3/plugins?page=1",
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "next_page_url": null,
    "path": "https://api.mile.app/api/v3/plugins",
    "per_page": 10,
    "prev_page_url": null,
    "to": 2,
    "total": 2
  }
}

GET

plugins

List add-ons/plugins

curl --request GET \
  --url https://apiweb.mile.app/api/v3/plugins \
  --header 'Authorization: Bearer <token>'

{
  "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": "user@mile.app",
        "updatedBy": "user@mile.app",
        "createdTime": "2025-08-31T10:30:00.000000Z",
        "updatedTime": "2025-08-31T10:35:00.000000Z",
        "organizationName": "MileApp",
        "isUsed": false,
        "customModuleId": null,
        "status": "active"
      }
    ],
    "first_page_url": "https://api.mile.app/api/v3/plugins?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.mile.app/api/v3/plugins?page=1",
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "next_page_url": null,
    "path": "https://api.mile.app/api/v3/plugins",
    "per_page": 10,
    "prev_page_url": null,
    "to": 2,
    "total": 2
  }
}

Authorizations

Authorization

string

header

required

Use a valid Bearer token to authenticate.

Query Parameters

string

Search query to filter plugins by name or description

Maximum string length: 255

sortBy

enum<string>

default:createdTime

Field to sort by

Available options:

name,

createdTime,

updatedTime,

usageCount

sortOrder

enum<string>

default:desc

Sort order (ascending or descending)

Available options:

asc,

desc

page

integer

default:1

Page number for pagination

Required range: 1 <= x <= 1000

limit

integer

default:10

Number of items per page (maximum 100)

Required range: 1 <= x <= 100

status

enum<string>

Filter by plugin status

Available options:

active,

inactive,

draft

Response

Plugins list retrieved successfully

status

boolean

required

Operation success status

Example:

true

message

string

required

Success message

Example:

"Success."

data

object

required

Laravel pagination response with plugin data

Show child attributes

data.current_page

integer

required

Current page number

Required range: x >= 1

Example:

1

data.data

object[]

required

Array of plugin objects for current page

Show child attributes

data.data.id

string

required

Unique plugin identifier (MongoDB ObjectId). Example: 68b440c9dad4c5d45707f6d2

data.data.name

string

required

Plugin display name (3-100 characters). Example: Custom Dashboard Widget

data.data.description

string

required

data.data.resourceFile

string

required

Original filename of the JavaScript resource. Example: 1756656087_Custom-Dashboard-Widget.js

data.data.organizationId

string

required

Organization identifier. 'system' for global plugins, organization ID for custom plugins. Example: 686cc0ff083ca8093204f002 or system

data.data.resourceUrl

string

required

Full URL where the JavaScript resource is hosted. Example: https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js

data.data.createdBy

string

required

Email address of the user who created the plugin. Example: user@mile.app

data.data.createdTime

string<date-time>

required

ISO 8601 timestamp when the plugin was created. Format: YYYY-MM-DDTHH:mm:ss.ffffffZ. Example: 2025-08-31T10:30:00.000000Z

data.data.updatedTime

string<date-time>

required

ISO 8601 timestamp when the plugin was last updated. Format: YYYY-MM-DDTHH:mm:ss.ffffffZ. Example: 2025-08-31T10:35:00.000000Z

data.data.organizationName

string

required

Organization display name. 'Global' for system plugins, actual organization name for custom plugins. Example: MileApp or Global

data.data.isUsed

boolean

required

Indicates if the plugin is currently active/installed in your organization. Example: false

data.data.icon

string | null

Full URL to the plugin icon (if available). Example: https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg

data.data.updatedBy

string | null

Email address of the user who last updated the plugin. May be null if never updated. Example: user@mile.app

data.data.customModuleId

string | null

ID of associated custom module or null if standalone. Example: null or 62846484ed5be87b6f4358f3

data.first_page_url

string

required

URL for first page

Example:

"https://api.mile.app/api/v3/plugins?page=1"

data.from

integer

required

First item number on current page

Required range: x >= 0

Example:

1

data.last_page

integer

required

Total number of pages

Required range: x >= 1

Example:

1

data.last_page_url

string

required

URL for last page

Example:

"https://api.mile.app/api/v3/plugins?page=1"

data.links

object[]

required

Pagination navigation links

Show child attributes

data.links.url

string

Link URL (null for disabled links)

data.links.label

string

Link display label

data.links.active

boolean

Whether link represents current page

data.next_page_url

string

required

URL for next page (null if last page)

Example:

null

data.path

string

required

Base API endpoint path

Example:

"https://api.mile.app/api/v3/plugins"

data.per_page

integer

required

Number of items per page

Required range: 1 <= x <= 100

Example:

10

data.prev_page_url

string

required

URL for previous page (null if first page)

Example:

null

data.to

integer

required

Last item number on current page

Required range: x >= 0

Example:

2

data.total

integer

required

Total number of plugins across all pages

Required range: x >= 0

Example:

2

Delete add-on/plugin Import/Export

⌘I

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects

Authorizations

Query Parameters

Response