Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mileapp.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
id
string
required

Unique add-on identifier (MongoDB ObjectId). Example: 68b440c9dad4c5d45707f6d2

​
name
string
required

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

​
description
string
required
​
resourceFile
string
required

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

​
organizationId
string
required

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

​
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

​
createdBy
string
required

Email address of the user who created the add-on. Example: user@mile.app

​
createdTime
string<date-time>
required

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

​
updatedTime
string<date-time>
required

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

​
organizationName
string
required

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

​
isUsed
boolean
required

Indicates if the add-on is currently active/installed in your organization. Example: false

​
icon
string | null

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

​
updatedBy
string | null

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

​
isPublished
boolean

Whether the add-on is published and visible to client users. Only applicable to system (global) add-ons.

Example:

true

​
customModuleId
string | null

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