{"items":[{"type":"link","label":"ESPER API REFERENCE","link":"/openapi","routeSlug":"/openapi"},{"type":"link","label":"Introduction","link":"/openapi/section/introduction","routeSlug":"/openapi/section/introduction"},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication"},{"type":"link","label":"Pagination","link":"/openapi/section/pagination","routeSlug":"/openapi/section/pagination"},{"type":"link","label":"Errors","link":"/openapi/section/errors","routeSlug":"/openapi/section/errors"},{"type":"link","label":"Rate Limits","link":"/openapi/section/rate-limits","routeSlug":"/openapi/section/rate-limits"},{"type":"link","label":"Change Log","link":"/openapi/section/change-log","routeSlug":"/openapi/section/change-log"},{"type":"separator","label":"ESPER CLOUD API"},{"type":"group","label":"Company Settings","link":"/openapi/esper_cloud_api_company-settings","routeSlug":"/openapi/esper_cloud_api_company-settings","items":[{"label":"Get your company settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_company-settings/getenterprise","routeSlug":"/openapi/esper_cloud_api_company-settings/getenterprise","metadata":{"seo":{"title":"Get your company settings","description":"Retrieves the current company settings for the specified enterprise.Use this endpoint to read enterprise-level configuration including contact information, location details, EMM enrollment status, and the enterprise's display name.About Get Company SettingsThis endpoint (formerly \"Get Enterprise Information\") returns the EnterpriseV1 object for your enterprise — the root configuration record that identifies your organization within Esper. It includes both read-only system fields (id, short_code, created_on, updated_on, emm) and user-editable fields such as name, contact details, and location. The emm field surfaces whether the enterprise is enrolled in Google EMM and, if so, its google_enterprise_id. All editable fields can be updated via PATCH /v1/enterprise/{enterprise_id}/."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/"},{"label":"Partially update company settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_company-settings/partialupdateenterprise","routeSlug":"/openapi/esper_cloud_api_company-settings/partialupdateenterprise","metadata":{"seo":{"title":"Partially update company settings","description":"Partially updates the company settings for the specified enterprise, returning the full updated record.Supply only the fields you want to change — all omitted fields retain their current values."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/"}]},{"type":"group","label":"Application","link":"/openapi/esper_cloud_api_application","routeSlug":"/openapi/esper_cloud_api_application","items":[{"label":"List apps in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getallapplications","routeSlug":"/openapi/esper_cloud_api_application/getallapplications","metadata":{"seo":{"title":"List apps in enterprise","description":"Alternative Available"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/"},{"label":"Get application information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getapplication","routeSlug":"/openapi/esper_cloud_api_application/getapplication","metadata":{"seo":{"title":"Get application information","description":"Lists all versions of a specific application registered in the enterprise library.Returns a paginated collection of AppVersion records for the specified application, filterable by version code, build number. Default page size is 20; results can be ordered by install count."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"Delete an application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/deleteapplication","routeSlug":"/openapi/esper_cloud_api_application/deleteapplication","metadata":{"seo":{"title":"Delete an application","description":"Alternative Available: DELETE /v1/enterprise/{enterprise_id}/application/{application_id}/To remove an iOS or Windows application version: DELETE /v2/tenant-apps/{appId}/versions/{versionId}Delete Android enterprise application. Permanently removes an application and all of its associated versions from the enterprise. Once deleted, the application can no longer be assigned to devices or policies and cannot be managed or distributed unless re-uploaded.Common Use Cases Removing deprecated or unsupported applications from the enterprise catalog, cleaning up unused or test applications, eliminating duplicate entries, and decommissioning applications no longer approved for distribution.Best Practices Before deleting, download a backup copy of the application package from the Apps section in the console — deletion is permanent and cannot be undone. Verify the application is not referenced in any active blueprints before calling this endpoint; an application associated with a blueprint must be removed from that blueprint first or the deletion will fail. Review device and policy assignments to avoid unintended disruption to managed devices.Note: This endpoint removes the entire application record along with all versions. To remove iOS or Windows tenant application versions individually, use DELETE /v2/tenant-apps/{appId}/versions/{versionId} instead.Workflow:"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"List App versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getappversions","routeSlug":"/openapi/esper_cloud_api_application/getappversions","metadata":{"seo":{"title":"List App versions","description":"Lists all versions of a specific application registered in the enterprise library."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/"},{"label":"Get app version information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getappversion","routeSlug":"/openapi/esper_cloud_api_application/getappversion","metadata":{"seo":{"title":"Get app version information","description":"Retrieves full details for a single application version by its UUID.Returns the AppVersion object including version code, build number, release name, release track, approval status, enabled/default state, SDK version constraints, and install count. Use when you need complete metadata on a specific version identified by version_id."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Delete app version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/deleteappversion","routeSlug":"/openapi/esper_cloud_api_application/deleteappversion","metadata":{"seo":{"title":"Delete app version","description":"Alternative Available: DELETE /v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/ To remove an iOS or Windows application version: DELETE /v2/tenant-apps/{appId}/versions/{versionId}"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Patch an App version instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/patchappversion","routeSlug":"/openapi/esper_cloud_api_application/patchappversion","metadata":{"seo":{"title":"Patch an App version instance","description":"Alternative Available: PATCH /v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/To update an iOS or Windows application version: PUT /v2/tenant-apps/{appId}/versions/{versionId}"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"List install devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getinstalldevices","routeSlug":"/openapi/esper_cloud_api_application/getinstalldevices","metadata":{"seo":{"title":"List install devices","description":"List all devices with a specific app version installed. Retrieves a paginated list of devices on which the specified application version is currently installed. Results can be searched by device name, device alias, or group name."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices"},{"label":"Upload an application to enterprise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/upload","routeSlug":"/openapi/esper_cloud_api_application/upload","metadata":{"seo":{"title":"Upload an application to enterprise","description":"⚠️ Android only. This endpoint accepts APK files and applies exclusively to Android-managed devices. See iOS and Windows application endpoints for Workflows."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/upload/"},{"label":"List Google enterprises","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getemminstances","routeSlug":"/openapi/esper_cloud_api_application/getemminstances","metadata":{"seo":{"title":"List Google enterprises","description":"List all Google Enterprise (EMM) instances for the enterprise. Retrieves all Google Enterprise bindings associated with the specified Esper enterprise, including the google_enterprise_id that links each binding to Google's EMM infrastructure."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm"},{"label":"Get Google enterprise information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getemminstance","routeSlug":"/openapi/esper_cloud_api_application/getemminstance","metadata":{"seo":{"title":"Get Google enterprise information","description":"Get a specific Google Enterprise (EMM) instance for the enterprise. Retrieves the details of a single Google Enterprise binding identified by emm_id, including its association with the Esper enterprise and the google_enterprise_id that links it to Google's EMM infrastructure."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}"},{"label":"List webtokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getwebtokens","routeSlug":"/openapi/esper_cloud_api_application/getwebtokens","metadata":{"seo":{"title":"List webtokens","description":"List all web tokens for a Google Enterprise (EMM) instance. Retrieves all web tokens associated with the specified EMM binding, including each token's value, parent_url, active status, and creation timestamp. Retrieve your webtoken from the Apps section of the console by using the inspector's network tab."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/"},{"label":"Creates a webtoken instance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/createwebtoken","routeSlug":"/openapi/esper_cloud_api_application/createwebtoken","metadata":{"seo":{"title":"Creates a webtoken instance","description":"We recommend enrolling in EMM (Google Play) through the UI. See Setting Up Google Play for more information. Create a new web token for a Google Enterprise (EMM) instance. Generates a new web token scoped to a specified parent_url, which can then be used to access the Managed Google Play interface within the Esper Console or a custom management application. Returns the created token including its id, token value, parent_url, and active status."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/"},{"label":"Get webtoken instance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getwebtokeninstance","routeSlug":"/openapi/esper_cloud_api_application/getwebtokeninstance","metadata":{"seo":{"title":"Get webtoken instance","description":"Get a specific web token for a Google Enterprise (EMM) instance. See Setting Up Google Play for more information. Retrieves the details of a single web token identified by webtoken_id, including its token value, associated emm ID, parent_url, active status, and creation timestamp."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"Updates webtoken instance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/updatewebtokeninstance","routeSlug":"/openapi/esper_cloud_api_application/updatewebtokeninstance","metadata":{"seo":{"title":"Updates webtoken instance","description":"See Setting Up Google Play for more information. We generally recommend updating the token via the UI. Update a specific web token for a Google Enterprise (EMM) instance. Performs a full replacement of the web token record identified by webtoken_id, updating its configuration and returning the updated token object."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"Patches webtoken instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/patchwebtokeninstance","routeSlug":"/openapi/esper_cloud_api_application/patchwebtokeninstance","metadata":{"seo":{"title":"Patches webtoken instance","description":"We recommend handling EMM updates through the UI. See Setting Up Google Play for more information. Partially update a specific web token for a Google Enterprise (EMM) instance. Applies a partial update to the web token record identified by webtoken_id, modifying only the fields included in the request body and returning the updated token object."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"Deletes a webtoken instance","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/deletewebtokeninstance","routeSlug":"/openapi/esper_cloud_api_application/deletewebtokeninstance","metadata":{"seo":{"title":"Deletes a webtoken instance","description":"We recommend unenrollment from the UI. See Setting Up Google Play for more information. Delete a specific web token for a Google Enterprise (EMM) instance. Permanently removes the web token identified by webtoken_id from the specified EMM instance. Returns an empty response on success (204 No Content). Reach out to Esper Support after unsubscribing from Managed Google Play."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"List Google Play applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getgoogleapps","routeSlug":"/openapi/esper_cloud_api_application/getgoogleapps","metadata":{"seo":{"title":"List Google Play applications","description":"List all Google Play applications approved for a Google Enterprise (EMM) instance. See Managing Google Play Apps for more information. Retrieves a paginated list of Google Play apps that have been approved and associated with the specified EMM binding, including each app's google_product_id, package_name, title, icon_url, min_sdk_version, active status, and approval state. Results can be filtered by google_product_id, package_name, or creation and update timestamps."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/"},{"label":"Post a Google play application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/addgoogleapp","routeSlug":"/openapi/esper_cloud_api_application/addgoogleapp","metadata":{"seo":{"title":"Post a Google play application","description":"Add a Google Play application to a Google Enterprise (EMM) instance. We recommend adding and approving Google Play applications through the UI. See Managing Google Play StoreApps for more information."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/"},{"label":"Get application information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getappinfo","routeSlug":"/openapi/esper_cloud_api_application/getappinfo","metadata":{"seo":{"title":"Get application information","description":"Get a specific Google Play application from a Google Enterprise (EMM) instance. Retrieves the full details of a single Google Play product record identified by product_id, including its google_product_id, package_name, title, icon_url, min_sdk_version, active status, and approval state."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"Update application instance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/updateappinfo","routeSlug":"/openapi/esper_cloud_api_application/updateappinfo","metadata":{"seo":{"title":"Update application instance","description":"Update or approve a specific Google Play application for a Google Enterprise (EMM) instance. We recommend handling Google Play application modifications via the UI. See Managing Google Play Store Apps for more information."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"Patch application instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/patchappinfo","routeSlug":"/openapi/esper_cloud_api_application/patchappinfo","metadata":{"seo":{"title":"Patch application instance","description":"Partially update specific fields of a managed Google Play application for a Google Enterprise (EMM) instance. We recommend handling Google Play application modifications via the UI. See Managing Google Play Store Apps for more information."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"Delete application instance","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/deleteappinstance","routeSlug":"/openapi/esper_cloud_api_application/deleteappinstance","metadata":{"seo":{"title":"Delete application instance","description":"Delete application. Permanently removes an application from the enterprise. This action deletes the application record and its associated metadata, preventing it from being assigned to devices, policies, or blueprints. Once deleted, the application cannot be managed or distributed unless it is re-uploaded."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"List product installations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/listproducts","routeSlug":"/openapi/esper_cloud_api_application/listproducts","metadata":{"seo":{"title":"List product installations","description":"List all installation records for Google Play applications on a Google Enterprise (EMM) instance. Retrieves a paginated list of installation records for the specified product, each representing the install state of the app on a specific GMS device. Results can be filtered by Google device ID, install state, version code, creation timestamp range, and active status."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}/install/"},{"label":"Gets minimum information regarding application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application/getminappinfo","routeSlug":"/openapi/esper_cloud_api_application/getminappinfo","metadata":{"seo":{"title":"Gets minimum information regarding application","description":"List minimal application information for all applications in the enterprise. Returns a lightweight list containing only the id (UUID) and package_name for each application uploaded to the enterprise. Use this endpoint instead of the full application list endpoints when you only need to look up an application_id by package name, or build a quick reference map of all applications in the enterprise without the overhead of retrieving full application metadata."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/applications-minimal/"}]},{"type":"group","label":"Application V1","link":"/openapi/esper_cloud_api_application-v1","routeSlug":"/openapi/esper_cloud_api_application-v1","items":[{"label":"List apps in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/getallapplicationsv1","routeSlug":"/openapi/esper_cloud_api_application-v1/getallapplicationsv1","metadata":{"seo":{"title":"List apps in enterprise","description":"Returns a paginated list of all Android applications uploaded to the enterprise, with optional filters for name, package name, category, SDK version, and more."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/"},{"label":"Get application information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/getapplicationv1","routeSlug":"/openapi/esper_cloud_api_application-v1/getapplicationv1","metadata":{"seo":{"title":"Get application information","description":"Alternative AvailableGET /enterprise/{enterprise_id}/application/{application_id}/"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"Delete an application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/deleteapplicationv1","routeSlug":"/openapi/esper_cloud_api_application-v1/deleteapplicationv1","metadata":{"seo":{"title":"Delete an application","description":"Permanently deletes an Android application record and all of its associated versions from the enterprise."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"List App versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/getappversionsv1","routeSlug":"/openapi/esper_cloud_api_application-v1/getappversionsv1","metadata":{"seo":{"title":"List App versions","description":"Lists all versions of a specific application using the V1 schema, which includes direct file and icon URLs, release date, and file size."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/"},{"label":"Get app version information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/getappversionv1","routeSlug":"/openapi/esper_cloud_api_application-v1/getappversionv1","metadata":{"seo":{"title":"Get app version information","description":"Retrieves full V1 details for a single application version by its UUID, including direct APK and icon URLs, file size, and release date."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Delete app version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/deleteappversionv1","routeSlug":"/openapi/esper_cloud_api_application-v1/deleteappversionv1","metadata":{"seo":{"title":"Delete app version","description":"Permanently removes a specific version of an enterprise application from Esper. If the target version is currently referenced by one or more blueprints, the version must be removed tfrom the blueprint before the version can be deleted. If no blueprint references exist, the version is deleted outright and the endpoint returns HTTP 204."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Patch an App version instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/patchappversionv1","routeSlug":"/openapi/esper_cloud_api_application-v1/patchappversionv1","metadata":{"seo":{"title":"Patch an App version instance","description":"Partially updates the metadata of a specific application version without modifying its APK or binary content.Use this endpoint to update human-readable labels. Only the fields included in the request body are modified; omitted fields remain unchanged."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"List install devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_application-v1/getinstalldevicesv1","routeSlug":"/openapi/esper_cloud_api_application-v1/getinstalldevicesv1","metadata":{"seo":{"title":"List install devices","description":"Returns a paginated list of devices that have a specific Android application version installed."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices"}]},{"type":"group","label":"AndroidDevice","link":"/openapi/esper_cloud_api_androiddevice","routeSlug":"/openapi/esper_cloud_api_androiddevice","items":[{"label":"Fetch all devices in an enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/getalldevices","routeSlug":"/openapi/esper_cloud_api_androiddevice/getalldevices","metadata":{"seo":{"title":"Fetch all devices in an enterprise","description":"⚠️ Android only. This endpoint applies exclusively to Android-managed devices enrolled in Esper. For other devices, use the other device management endpoints."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/"},{"label":"Fetch device details by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/getdevicebyid","routeSlug":"/openapi/esper_cloud_api_androiddevice/getdevicebyid","metadata":{"seo":{"title":"Fetch device details by ID","description":"⚠️ Android only. This endpoint applies exclusively to Android-managed devices enrolled in Esper."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/"},{"label":"List all device apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/getdeviceapps","routeSlug":"/openapi/esper_cloud_api_androiddevice/getdeviceapps","metadata":{"seo":{"title":"List all device apps","description":"⚠️ Android only. This endpoint applies exclusively to Android-managed devices enrolled in Esper.Alternative Available"}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/app/"},{"label":"Get device app details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/getdeviceappbyid","routeSlug":"/openapi/esper_cloud_api_androiddevice/getdeviceappbyid","metadata":{"seo":{"title":"Get device app details","description":"Get details of a specific app installed on an Android device. Retrieves the full DeviceApp record for a single app identified by app_id on the specified Android device, including the app's app_name, package_name, state, app_type, version_code, version_name, is_active, is_kiosk_app, is_esper_controlled, whitelisted, is_data_clearable, and is_uninstallable fields."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/app/{app_id}/"},{"label":"List installed apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/getappinstalls","routeSlug":"/openapi/esper_cloud_api_androiddevice/getappinstalls","metadata":{"seo":{"title":"List installed apps","description":"Get details of a specific app installed on an Android device. Retrieves the full DeviceApp record for a single app identified by app_id on the specified Android device, including the app's app_name, package_name, state, app_type, version_code, version_name, is_active, is_kiosk_app, is_esper_controlled, whitelisted, is_data_clearable, and is_uninstallable fields."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/install/"},{"label":"Get latest device event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/getdeviceevent","routeSlug":"/openapi/esper_cloud_api_androiddevice/getdeviceevent","metadata":{"seo":{"title":"Get latest device event","description":"Get the latest status event for an Android device. Retrieves the most recent DeviceStatus record for the specified Android device, containing a data payload with the device's current telemetry snapshot — including battery, connectivity, memory, storage, and other real-time device state information — along with the associated device and enterprise references and the event created_on timestamp.This endpoint is for Android devices only. For other platforms, use the following alternatives:"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/status/"},{"label":"Download Event Feed for Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get","routeSlug":"/openapi/esper_cloud_api_androiddevice/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get","metadata":{"seo":{"title":"Download Event Feed for Device","description":"Download the event feed for an Android device. Retrieves a paginated, chronologically ordered list of EventFeed records for the specified Android device, each containing an event id, message_id, device_status_id, created_on timestamp, and a message describing what occurred — including commands issued, who issued them, and from which state they were issued. Results default to 250 records per page."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/download/eventfeed/"},{"label":"Download Event Feed for Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get","routeSlug":"/openapi/esper_cloud_api_androiddevice/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get","metadata":{"seo":{"title":"Download Event Feed for Group","description":"Download the event feed for an Android device group. Retrieves a paginated, chronologically ordered list of command request records for the specified group, each containing details of operations issued to the group. Results default to 250 records per page."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/group/{group_id}/download/eventfeed/"},{"label":"Lists event feed for device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_androiddevice/geteventfeed","routeSlug":"/openapi/esper_cloud_api_androiddevice/geteventfeed","metadata":{"seo":{"title":"Lists event feed for device","description":"List event feed for device. Retrieves a device’s event history, including command activity and system events, in reverse-chronological order. The response is paginated and returns entries in the results array."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/device/{device_id}/report/eventfeed/"}]},{"type":"group","label":"Device Group","link":"/openapi/esper_cloud_api_device-group","routeSlug":"/openapi/esper_cloud_api_device-group","items":[{"label":"List device groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/getallgroups","routeSlug":"/openapi/esper_cloud_api_device-group/getallgroups","metadata":{"seo":{"title":"List device groups","description":"Returns a paginated list of all device groups in the enterprise. Device groups organize devices into logical collections by location, use case, or deployment stage, and serve as the primary unit for policy assignment, app deployment, and bulk commands."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/"},{"label":"Create a device group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/creategroup","routeSlug":"/openapi/esper_cloud_api_device-group/creategroup","metadata":{"seo":{"title":"Create a device group","description":"Creates a new device group within the enterprise. Device groups organize devices into logical collections for policy assignment, app deployment, Blueprint application, and bulk command targeting. Groups can be nested — pass a parent group ID to create a subgroup within an existing group hierarchy."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/"},{"label":"Get device group information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/getgroupbyid","routeSlug":"/openapi/esper_cloud_api_device-group/getgroupbyid","metadata":{"seo":{"title":"Get device group information","description":"Retrieves full details for a single device group by its UUID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Update device group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/updategroup","routeSlug":"/openapi/esper_cloud_api_device-group/updategroup","metadata":{"seo":{"title":"Update device group","description":"Fully updates a device group's properties using the action query parameter to specify the operation being performed. This endpoint controls group membership, naming, and hierarchy — use it to add or remove devices, rename a group, or move it to a different parent in the group tree."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Delete a device group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/deletegroup","routeSlug":"/openapi/esper_cloud_api_device-group/deletegroup","metadata":{"seo":{"title":"Delete a device group","description":"Permanently deletes a device group from the enterprise. The group must be empty — groups containing one or more devices cannot be deleted. Move all member devices to another group first before issuing the delete request."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Partially update a device group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/partialupdategroup","routeSlug":"/openapi/esper_cloud_api_device-group/partialupdategroup","metadata":{"seo":{"title":"Partially update a device group","description":"Partially updates one or more properties of a device group without requiring all fields to be present in the request body. Like the full update endpoint, the action query parameter specifies the operation being performed — but here only the fields relevant to that action need to be included. Use this endpoint instead of PUT when making a single targeted change, such as renaming a group or adding a small set of devices, without needing to supply the full group object."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Upload a thumbnail pic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/uploadgroupthumbnail","routeSlug":"/openapi/esper_cloud_api_device-group/uploadgroupthumbnail","metadata":{"seo":{"title":"Upload a thumbnail pic","description":"Upload an image to represent the group in Devices & Groups."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/"},{"label":"List thumbnail pics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/listgroupthumbnail","routeSlug":"/openapi/esper_cloud_api_device-group/listgroupthumbnail","metadata":{"seo":{"title":"List thumbnail pics","description":"Get a list of group thumbnail image files in Devices & Groups."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/"},{"label":"Get thumbnail detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/getgroupthumbnail","routeSlug":"/openapi/esper_cloud_api_device-group/getgroupthumbnail","metadata":{"seo":{"title":"Get thumbnail detail","description":"Get a thumbnail by its ID. Use List thumbnail pics to find thumbnail IDs."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/"},{"label":"Delete group thumbnail","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/deletegroupthumbnail","routeSlug":"/openapi/esper_cloud_api_device-group/deletegroupthumbnail","metadata":{"seo":{"title":"Delete group thumbnail","description":"Delete a thumbnail in Devices & Groups."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/"},{"label":"List the subgroups of list of groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-group/getallsubgroups","routeSlug":"/openapi/esper_cloud_api_device-group/getallsubgroups","metadata":{"seo":{"title":"List the subgroups of list of groups","description":"Returns a list of subgroup UUIDs for one or more parent groups. Use the parent_group_ids parameter to specify which parent groups to query, and the immediate parameter to control whether the response includes only direct children or all descendants at every level of the hierarchy."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/api/v2/subgroups/"}]},{"type":"group","label":"Token (Deprecated)","link":"/openapi/esper_cloud_api_token-(deprecated)","routeSlug":"/openapi/esper_cloud_api_token-(deprecated)","items":[{"label":"Renew Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_token-(deprecated)/renewtoken","routeSlug":"/openapi/esper_cloud_api_token-(deprecated)/renewtoken","metadata":{"seo":{"title":"Renew Token","description":"API to renew your token"}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v0/enterprise/{enterprise_id}/developerapp/{developerapp_id}/renew-token/"},{"label":"Token Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_token-(deprecated)/gettokeninfo","routeSlug":"/openapi/esper_cloud_api_token-(deprecated)/gettokeninfo","metadata":{"seo":{"title":"Token Information","description":"API to get resource information associated with your token like your enterprise, user etc"}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v1/token-info/"}]},{"type":"group","label":"Commands V2","link":"/openapi/esper_cloud_api_commands-v2","routeSlug":"/openapi/esper_cloud_api_commands-v2","items":[{"label":"List command requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_commands-v2/listcommandrequest","routeSlug":"/openapi/esper_cloud_api_commands-v2/listcommandrequest","metadata":{"seo":{"title":"List command requests","description":"Alternative Available (recommended): For broader multi-OS support and enhanced command visibility, use the stable command request API: https://api.esper.io/openapi/command-request/listcommandrequests"}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/command/"},{"label":"Create a command request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_commands-v2/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/post","routeSlug":"/openapi/esper_cloud_api_commands-v2/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/post","metadata":{"seo":{"title":"Create a command request","description":"⚠️ Android only. This endpoint issues commands to Android-managed devices."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/command/"},{"label":"get status list for command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_commands-v2/getcommandrequeststatus","routeSlug":"/openapi/esper_cloud_api_commands-v2/getcommandrequeststatus","metadata":{"seo":{"title":"get status list for command request","description":"⚠️ Android only. This endpoint applies to command requests issued to Android-managed devices."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/command/{request_id}/status/"},{"label":"get command history for device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_commands-v2/getdevicecommandhistory","routeSlug":"/openapi/esper_cloud_api_commands-v2/getdevicecommandhistory","metadata":{"seo":{"title":"get command history for device","description":"⚠️ Android only. This endpoint applies exclusively to Android-managed devices enrolled in Esper."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/device/{device_id}/command-history/"}]},{"type":"group","label":"Enterprise Policy","link":"/openapi/esper_cloud_api_enterprise-policy","routeSlug":"/openapi/esper_cloud_api_enterprise-policy","items":[{"label":"List all policies in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_enterprise-policy/listpolicies","routeSlug":"/openapi/esper_cloud_api_enterprise-policy/listpolicies","metadata":{"seo":{"title":"List all policies in enterprise","description":"Returns Policies list"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/"},{"label":"Create a new Enterprise Policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_enterprise-policy/createpolicy","routeSlug":"/openapi/esper_cloud_api_enterprise-policy/createpolicy","metadata":{"seo":{"title":"Create a new Enterprise Policy","description":"API to create a new Enterprise Policy"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/"},{"label":"Get Enterprise Policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_enterprise-policy/getpolicybyid","routeSlug":"/openapi/esper_cloud_api_enterprise-policy/getpolicybyid","metadata":{"seo":{"title":"Get Enterprise Policy","description":"Returns EnterprisePolicy instance"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"},{"label":"Update Enterprise Policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_enterprise-policy/updatepolicy","routeSlug":"/openapi/esper_cloud_api_enterprise-policy/updatepolicy","metadata":{"seo":{"title":"Update Enterprise Policy","description":"Enterprise/Compliance Policies are a legacy service and may not be generally available to all customers."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"},{"label":"Delete a Enterprise Policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_enterprise-policy/deleteenterprisepolicy","routeSlug":"/openapi/esper_cloud_api_enterprise-policy/deleteenterprisepolicy","metadata":{"seo":{"title":"Delete a Enterprise Policy","description":"Emtpy response"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"},{"label":"Partial update EnterprisePolicy","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_enterprise-policy/partialupdatepolicy","routeSlug":"/openapi/esper_cloud_api_enterprise-policy/partialupdatepolicy","metadata":{"seo":{"title":"Partial update EnterprisePolicy","description":"Returns EnterprisePolicy instance"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"}]},{"type":"group","label":"Geofence","link":"/openapi/esper_cloud_api_geofence","routeSlug":"/openapi/esper_cloud_api_geofence","items":[{"label":"List Geofences in Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/getallgeofences","routeSlug":"/openapi/esper_cloud_api_geofence/getallgeofences","metadata":{"seo":{"title":"List Geofences in Enterprise","description":"Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/"},{"label":"Get geofence information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/getgeofence","routeSlug":"/openapi/esper_cloud_api_geofence/getgeofence","metadata":{"seo":{"title":"Get geofence information","description":"⚠️ Legacy endpoint. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Update geofence information","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/updategeofence","routeSlug":"/openapi/esper_cloud_api_geofence/updategeofence","metadata":{"seo":{"title":"Update geofence information","description":"⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Delete a geofence","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/deletegeofence","routeSlug":"/openapi/esper_cloud_api_geofence/deletegeofence","metadata":{"seo":{"title":"Delete a geofence","description":"⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Partially updates geofence information","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/partialupdategeofence","routeSlug":"/openapi/esper_cloud_api_geofence/partialupdategeofence","metadata":{"seo":{"title":"Partially updates geofence information","description":"⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Create a geofence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/creategeofence","routeSlug":"/openapi/esper_cloud_api_geofence/creategeofence","metadata":{"seo":{"title":"Create a geofence","description":"⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/"},{"label":"List Geofences in Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/getgeofencelist","routeSlug":"/openapi/esper_cloud_api_geofence/getgeofencelist","metadata":{"seo":{"title":"List Geofences in Enterprise","description":"⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/"},{"label":"Get geofence information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/getthegeofence","routeSlug":"/openapi/esper_cloud_api_geofence/getthegeofence","metadata":{"seo":{"title":"Get geofence information","description":"⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/"},{"label":"Delete a geofence","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_geofence/deletethegeofence","routeSlug":"/openapi/esper_cloud_api_geofence/deletethegeofence","metadata":{"seo":{"title":"Delete a geofence","description":"⚠️ Legacy endpoint. Android only. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward."}},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/"}]},{"type":"group","label":"Content","link":"/openapi/esper_cloud_api_content","routeSlug":"/openapi/esper_cloud_api_content","items":[{"label":"List content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_content/getallcontent","routeSlug":"/openapi/esper_cloud_api_content/getallcontent","metadata":{"seo":{"title":"List content","description":"Returns a paginated list of all files uploaded to the enterprise's Content Management library. Each result includes file metadata such as MIME type, size, tags, description, path, and ownership — but not the file content itself. Use this endpoint to discover content IDs for use in downstream operations such as pushing files to devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/"},{"label":"Get content information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_content/getcontent","routeSlug":"/openapi/esper_cloud_api_content/getcontent","metadata":{"seo":{"title":"Get content information","description":"Returns metadata for a single content item in the enterprise's Content Management library, identified by its content_id. The response includes the same fields as the list endpoint — filename, MIME type, size, tags, description, path, and ownership — but scoped to a single file. Does not return the file's binary content."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/{content_id}/"},{"label":"Delete Content","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_content/deletecontent","routeSlug":"/openapi/esper_cloud_api_content/deletecontent","metadata":{"seo":{"title":"Delete Content","description":"Permanently deletes a content item from the enterprise's Content Management library by content_id. This action is irreversible — the file and its metadata are removed immediately and cannot be recovered."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/{content_id}/"},{"label":"Patch a content instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_content/patchcontent","routeSlug":"/openapi/esper_cloud_api_content/patchcontent","metadata":{"seo":{"title":"Patch a content instance","description":"Partially updates the metadata of an existing content item in the enterprise's Content Management library. Only tags and description can be updated — the file itself and its core properties (filename, size, MIME type, path) cannot be modified through this endpoint."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/{content_id}/"},{"label":"Upload new content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_content/postcontent","routeSlug":"/openapi/esper_cloud_api_content/postcontent","metadata":{"seo":{"title":"Upload new content","description":"Uploads a file to the enterprise content library, creating a new Content record.Accepts a multipart/form-data payload with the binary file in the key field and returns the resulting Content object including id, download_url, MIME type, hash, and size. This is the primary mechanism for adding files to Esper's content library for device distribution."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/upload/"},{"label":"Upload file to Remote File Manager","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_content/uploadremotefile","routeSlug":"/openapi/esper_cloud_api_content/uploadremotefile","metadata":{"seo":{"title":"Upload file to Remote File Manager","description":"Uploads a file to the Remote File Manager bucket for temporary storage."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/remote-file/"},{"label":"Generate download URL for existing file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_content/generatedownloadurl","routeSlug":"/openapi/esper_cloud_api_content/generatedownloadurl","metadata":{"seo":{"title":"Generate download URL for existing file","description":"Generates a new pre-signed download URL for a file already stored in the Remote File Manager bucket."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/remote-file/generate_download_url/"}]},{"type":"group","label":"User (Deprecated)","link":"/openapi/esper_cloud_api_user-(deprecated)","routeSlug":"/openapi/esper_cloud_api_user-(deprecated)","items":[{"label":"Create a new User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user-(deprecated)/createuser","routeSlug":"/openapi/esper_cloud_api_user-(deprecated)/createuser","metadata":{"seo":{"title":"Create a new User","description":"Create a new User"}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/"},{"label":"Update a User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user-(deprecated)/updateuser","routeSlug":"/openapi/esper_cloud_api_user-(deprecated)/updateuser","metadata":{"seo":{"title":"Update a User","description":"Update a User"}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/{user_id}/"},{"label":"Partial update a User","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user-(deprecated)/partialupdateuser","routeSlug":"/openapi/esper_cloud_api_user-(deprecated)/partialupdateuser","metadata":{"seo":{"title":"Partial update a User","description":"Partial update a User"}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/{user_id}/"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user-(deprecated)/userdelete","routeSlug":"/openapi/esper_cloud_api_user-(deprecated)/userdelete","metadata":{"seo":{"title":"Delete a user","description":"Delete a user"}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/{user_id}/"}]},{"type":"group","label":"User","link":"/openapi/esper_cloud_api_user","routeSlug":"/openapi/esper_cloud_api_user","items":[{"label":"User information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/userinfo","routeSlug":"/openapi/esper_cloud_api_user/userinfo","metadata":{"seo":{"title":"User information","description":"Retrieves the profile and account details of the authenticated user associated with the current API key."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/user_info/"},{"label":"Invite a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/tenantuserinvite","routeSlug":"/openapi/esper_cloud_api_user/tenantuserinvite","metadata":{"seo":{"title":"Invite a user","description":"Sends an invitation email to a new user, provisioning their role and group access within the specified tenant before they have an Esper account."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/invite"},{"label":"List user invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/gettenantuserinvites","routeSlug":"/openapi/esper_cloud_api_user/gettenantuserinvites","metadata":{"seo":{"title":"List user invites","description":"Returns all pending user invitations for the specified tenant, including each invite's status, metadata, and assigned role."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/invite"},{"label":"Delete a invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/deletetenantuserinvite","routeSlug":"/openapi/esper_cloud_api_user/deletetenantuserinvite","metadata":{"seo":{"title":"Delete a invite","description":"Cancels and removes a specific pending user invitation from the tenant, preventing the invited user from completing registration with that invite link."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/invite/{invite_id}"},{"label":"Get Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/getusers","routeSlug":"/openapi/esper_cloud_api_user/getusers","metadata":{"seo":{"title":"Get Users","description":"Returns a paginated list of all users in the tenant, including their profile details, role assignments, and account status."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/user/"},{"label":"Get User Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/getuser","routeSlug":"/openapi/esper_cloud_api_user/getuser","metadata":{"seo":{"title":"Get User Information","description":"Retrieves the full profile and account details for a specific user by their integer user ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/user/{user_id}/"},{"label":"Update user role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/updatedifferentuser","routeSlug":"/openapi/esper_cloud_api_user/updatedifferentuser","metadata":{"seo":{"title":"Update user role","description":"Updates the role, group assignments, and access scope for a specific user within the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/users/{user_id}"},{"label":"Update user profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/updateownuser","routeSlug":"/openapi/esper_cloud_api_user/updateownuser","metadata":{"seo":{"title":"Update user profile","description":"Updates the authenticated user's own profile details."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/user/{user_id}"},{"label":"Get user groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/getusergroups","routeSlug":"/openapi/esper_cloud_api_user/getusergroups","metadata":{"seo":{"title":"Get user groups","description":"Returns the device groups a specific user has access to, based on their role and group assignments."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/users/{user_id}/groups"},{"label":"Delete a user from Enterprise","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/deletetenantuser","routeSlug":"/openapi/esper_cloud_api_user/deletetenantuser","metadata":{"seo":{"title":"Delete a user from Enterprise","description":"Removes a specific user from the tenant, revoking their access to all Esper resources within that enterprise."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/user/{user_id}/"},{"label":"Get Users details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_user/paths/~1authn2~1v1~1users~1/get","routeSlug":"/openapi/esper_cloud_api_user/paths/~1authn2~1v1~1users~1/get","metadata":{"seo":{"title":"Get Users details","description":"Retrieves the list of users belonging to the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v1/users/"}]},{"type":"group","label":"Blueprint (Deprecated)","link":"/openapi/esper_cloud_api_blueprint-(deprecated)","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)","items":[{"label":"Get list of Blueprints for the group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/listblueprint","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/listblueprint","metadata":{"seo":{"title":"Get list of Blueprints for the group","description":"Return list of Blueprint instances for the group."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/"},{"label":"Create a Blueprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/createblueprint","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/createblueprint","metadata":{"seo":{"title":"Create a Blueprint","description":"Returns the created Blueprint instance."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/"},{"label":"Get Blueprint detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/getblueprint","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/getblueprint","metadata":{"seo":{"title":"Get Blueprint detail","description":"Returns the details of a Blueprint instance."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/"},{"label":"Partial update a Blueprint","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/partialupdateblueprint","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/partialupdateblueprint","metadata":{"seo":{"title":"Partial update a Blueprint","description":"Returns the details of the updated Blueprint instance."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/"},{"label":"Delete a Blueprint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/deleteblueprint","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/deleteblueprint","metadata":{"seo":{"title":"Delete a Blueprint","description":"Deletes the requested Blueprint instance."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/"},{"label":"Get list of Blueprint Revisions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/listblueprintrevisions","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/listblueprintrevisions","metadata":{"seo":{"title":"Get list of Blueprint Revisions","description":"Returns a list of Blueprint Revisions instances for the given Blueprint."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/"},{"label":"Get Blueprint Revision detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/getblueprintrevision","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/getblueprintrevision","metadata":{"seo":{"title":"Get Blueprint Revision detail","description":"Returns the detail of Blueprint Revision instance."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/{revision_id}/"},{"label":"Restore a Blueprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/restoreblueprintrevision","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/restoreblueprintrevision","metadata":{"seo":{"title":"Restore a Blueprint","description":"Returns the Blueprint instance restored to the requested Blueprint Revision."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/restore/"},{"label":"Upload a Blueprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_blueprint-(deprecated)/uploadblueprint","routeSlug":"/openapi/esper_cloud_api_blueprint-(deprecated)/uploadblueprint","metadata":{"seo":{"title":"Upload a Blueprint","description":"Create a Blueprint by uploading a json file."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/upload/"}]},{"type":"group","label":"Directory Record","link":"/openapi/esper_cloud_api_directory-record","routeSlug":"/openapi/esper_cloud_api_directory-record","items":[{"label":"Get all Directory Records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_directory-record/getdirectoryrecords","routeSlug":"/openapi/esper_cloud_api_directory-record/getdirectoryrecords","metadata":{"seo":{"title":"Get all Directory Records","description":"⚠️ Deprecation Notice: The following endpoint is deprecated."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/"},{"label":"Create a new Directory Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_directory-record/createdirectoryrecord","routeSlug":"/openapi/esper_cloud_api_directory-record/createdirectoryrecord","metadata":{"seo":{"title":"Create a new Directory Record","description":"⚠️ Deprecation Notice: The following endpoint is deprecated."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/"},{"label":"Get details about a Directory Record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_directory-record/getdirectoryrecord","routeSlug":"/openapi/esper_cloud_api_directory-record/getdirectoryrecord","metadata":{"seo":{"title":"Get details about a Directory Record","description":"⚠️ Deprecation Notice: The following endpoint is deprecated."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/"},{"label":"Update a Directory Record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_directory-record/updatedirectoryrecord","routeSlug":"/openapi/esper_cloud_api_directory-record/updatedirectoryrecord","metadata":{"seo":{"title":"Update a Directory Record","description":"⚠️ Deprecation Notice: The following endpoint is deprecated."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/"},{"label":"Delete a Directory Record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_directory-record/deletedirectoryrecord","routeSlug":"/openapi/esper_cloud_api_directory-record/deletedirectoryrecord","metadata":{"seo":{"title":"Delete a Directory Record","description":"⚠️ Deprecation Notice: The following endpoint is deprecated."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/"}]},{"type":"group","label":"Tile Icon","link":"/openapi/esper_cloud_api_tile-icon","routeSlug":"/openapi/esper_cloud_api_tile-icon","items":[{"label":"Get List of Device Tile Icons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_tile-icon/gettileicons","routeSlug":"/openapi/esper_cloud_api_tile-icon/gettileicons","metadata":{"seo":{"title":"Get List of Device Tile Icons","description":"Returns list of tile icons"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/"},{"label":"Create a  tile icon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_tile-icon/addtileicon","routeSlug":"/openapi/esper_cloud_api_tile-icon/addtileicon","metadata":{"seo":{"title":"Create a  tile icon","description":"Create a tile icon."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/"},{"label":"Get instance of a tile icon","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_tile-icon/gettileicon","routeSlug":"/openapi/esper_cloud_api_tile-icon/gettileicon","metadata":{"seo":{"title":"Get instance of a tile icon","description":"Get a tile icon."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/"},{"label":"Delete a tile icon","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_tile-icon/deletetileicon","routeSlug":"/openapi/esper_cloud_api_tile-icon/deletetileicon","metadata":{"seo":{"title":"Delete a tile icon","description":"Deletes a title icon"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/"},{"label":"Set a tile icon for a device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_tile-icon/applytileicon","routeSlug":"/openapi/esper_cloud_api_tile-icon/applytileicon","metadata":{"seo":{"title":"Set a tile icon for a device","description":"Apply a tile icon to a device."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icon-apply/"},{"label":"Removes tile icon for device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_tile-icon/removetileicon","routeSlug":"/openapi/esper_cloud_api_tile-icon/removetileicon","metadata":{"seo":{"title":"Removes tile icon for device","description":"Returns the model of the device(s)"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icon-unapply/"}]},{"type":"group","label":"Alerts","link":"/openapi/esper_cloud_api_alerts","routeSlug":"/openapi/esper_cloud_api_alerts","items":[{"label":"List alert channels in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alerts/listalertchannels","routeSlug":"/openapi/esper_cloud_api_alerts/listalertchannels","metadata":{"seo":{"title":"List alert channels in enterprise","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/"},{"label":"Creates alert channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alerts/createalertchannel","routeSlug":"/openapi/esper_cloud_api_alerts/createalertchannel","metadata":{"seo":{"title":"Creates alert channel","description":"Creates a new alert channel in the enterprise, defining a notification destination to be used when alarm rules are triggered. Alert channels are prerequisites for alarm rules — a channel must exist before it can be linked to any rule. Currently, email is the supported delivery type."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/"},{"label":"Get alert channel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alerts/getalertchannel","routeSlug":"/openapi/esper_cloud_api_alerts/getalertchannel","metadata":{"seo":{"title":"Get alert channel","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"},{"label":"Update alert channel information","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alerts/updatealertchannel","routeSlug":"/openapi/esper_cloud_api_alerts/updatealertchannel","metadata":{"seo":{"title":"Update alert channel information","description":"Fully updates an existing alert channel identified by its integer alert_id. All writable fields should be included in the request body — this is a full replacement operation, not a partial update. To change only one field without affecting others, use PATCH /v1/enterprise/{enterprise_id}/alertchannels/{alert_id} instead."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"},{"label":"Partially updates alert channel information","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alerts/patchalertchannel","routeSlug":"/openapi/esper_cloud_api_alerts/patchalertchannel","metadata":{"seo":{"title":"Partially updates alert channel information","description":"Partially updates one or more fields of an existing alert channel identified by its integer alert_id. Only the fields included in the request body are modified — omitted fields retain their current values. Use this endpoint instead of PUT when making a targeted change to a single field without needing to resend the full channel object."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"},{"label":"Delete an alert channel","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alerts/deletealertchannel","routeSlug":"/openapi/esper_cloud_api_alerts/deletealertchannel","metadata":{"seo":{"title":"Delete an alert channel","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"}]},{"type":"group","label":"Alarms","link":"/openapi/esper_cloud_api_alarms","routeSlug":"/openapi/esper_cloud_api_alarms","items":[{"label":"Get list of alarm rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alarms/getalarmrules","routeSlug":"/openapi/esper_cloud_api_alarms/getalarmrules","metadata":{"seo":{"title":"Get list of alarm rules","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/"},{"label":"Creates instance of alarm rules","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alarms/addalarmrule","routeSlug":"/openapi/esper_cloud_api_alarms/addalarmrule","metadata":{"seo":{"title":"Creates instance of alarm rules","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/"},{"label":"Get instance of alarm rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alarms/getalarmrule","routeSlug":"/openapi/esper_cloud_api_alarms/getalarmrule","metadata":{"seo":{"title":"Get instance of alarm rule","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Update alarm rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alarms/updatealarmrule","routeSlug":"/openapi/esper_cloud_api_alarms/updatealarmrule","metadata":{"seo":{"title":"Update alarm rules","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Partially updates alarm rules","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alarms/patchalarmrule","routeSlug":"/openapi/esper_cloud_api_alarms/patchalarmrule","metadata":{"seo":{"title":"Partially updates alarm rules","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Deletes alarm rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alarms/deletealarmrule","routeSlug":"/openapi/esper_cloud_api_alarms/deletealarmrule","metadata":{"seo":{"title":"Deletes alarm rule","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Get history of alarm rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_alarms/getalarmhistory","routeSlug":"/openapi/esper_cloud_api_alarms/getalarmhistory","metadata":{"seo":{"title":"Get history of alarm rule","description":"⚠️ Android only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/alarmhistory/"}]},{"type":"group","label":"Wallpapers","link":"/openapi/esper_cloud_api_wallpapers","routeSlug":"/openapi/esper_cloud_api_wallpapers","items":[{"label":"Get list of wallpapers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_wallpapers/getwallpapers","routeSlug":"/openapi/esper_cloud_api_wallpapers/getwallpapers","metadata":{"seo":{"title":"Get list of wallpapers","description":"Returns a paginated list of all wallpaper images uploaded to the enterprise. Each result includes the image URL, thumbnail URL, orientation, and active status. Wallpapers can be uploaded directly via the API or may have been added through a blueprint configuration."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/"},{"label":"Create wallpaper","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_wallpapers/addwallpaper","routeSlug":"/openapi/esper_cloud_api_wallpapers/addwallpaper","metadata":{"seo":{"title":"Create wallpaper","description":"Uploads a new wallpaper image to the enterprise. The image is submitted as a multipart/form-data request and, once uploaded, can be referenced by wallpaper_id in Windows blueprint homescreen and lock screen settings. There is no dedicated wallpaper library in the console. Wallpapers are only visible by previewing their associated blueprint."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/"},{"label":"Get instance of wallpaper","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_wallpapers/getwallpaper","routeSlug":"/openapi/esper_cloud_api_wallpapers/getwallpaper","metadata":{"seo":{"title":"Get instance of wallpaper","description":"Returns the details of a single wallpaper image identified by its UUID wallpaper_id, including the full-resolution image URL, thumbnail URL, orientation, and active status. There is no dedicated wallpaper library in the Console — wallpapers are only visible by previewing the blueprint they are associated with, making this endpoint the primary way to retrieve details for a specific wallpaper programmatically."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/"},{"label":"Deletes instance of wallpaper","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_wallpapers/deletewallpaper","routeSlug":"/openapi/esper_cloud_api_wallpapers/deletewallpaper","metadata":{"seo":{"title":"Deletes instance of wallpaper","description":"Permanently deletes a wallpaper image from the enterprise identified by its UUID wallpaper_id. This action is irreversible. Since there is no dedicated wallpaper library in the Console, use GET /v1/enterprise/{enterprise_id}/wallpaper/ to confirm the correct wallpaper_id before deleting."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/"}]},{"type":"group","label":"Device Telemetry","link":"/openapi/esper_cloud_api_device-telemetry","routeSlug":"/openapi/esper_cloud_api_device-telemetry","items":[{"label":"Get list of device locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-telemetry/getdevicelocations","routeSlug":"/openapi/esper_cloud_api_device-telemetry/getdevicelocations","metadata":{"seo":{"title":"Get list of device locations","description":"Lists reported location data for devices in an enterprise."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/location/"},{"label":"Get location of specific device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-telemetry/getspecificlocations","routeSlug":"/openapi/esper_cloud_api_device-telemetry/getspecificlocations","metadata":{"seo":{"title":"Get location of specific device","description":"Retrieves a single reported device location record by ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/location/{location_id}/"},{"label":"Get list of device tiles reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-telemetry/getdevicetilereports","routeSlug":"/openapi/esper_cloud_api_device-telemetry/getdevicetilereports","metadata":{"seo":{"title":"Get list of device tiles reports","description":"Returns list of device tiles reports"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/device-tiles/"},{"label":"Get instance of device tiles report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-telemetry/getdevicetilereport","routeSlug":"/openapi/esper_cloud_api_device-telemetry/getdevicetilereport","metadata":{"seo":{"title":"Get instance of device tiles report","description":"Returns instance of device tiles report"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/device-tiles/{device_tiles_id}/"},{"label":"Get status metrics report for enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-telemetry/getstatusmetrics","routeSlug":"/openapi/esper_cloud_api_device-telemetry/getstatusmetrics","metadata":{"seo":{"title":"Get status metrics report for enterprise","description":"Returns status metrics report for enterprise"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/status-metrics/"},{"label":"Get status metrics report for enterprise v2","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_device-telemetry/getstatusmetricsv2","routeSlug":"/openapi/esper_cloud_api_device-telemetry/getstatusmetricsv2","metadata":{"seo":{"title":"Get status metrics report for enterprise v2","description":"Returns status metrics report for enterprise"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/enterprise/{enterprise_id}/report/status-metrics"}]},{"type":"group","label":"Daily and Custom Reports","link":"/openapi/esper_cloud_api_daily-and-custom-reports","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports","items":[{"label":"Get report information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/paths/~1enterprise~1report~1info~1/get","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/paths/~1enterprise~1report~1info~1/get","metadata":{"seo":{"title":"Get report information","description":"⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/info/"},{"label":"Get device status reports within specified date-time range","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/getdevicereport","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/getdevicereport","metadata":{"seo":{"title":"Get device status reports within specified date-time range","description":"⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/device-report/"},{"label":"Get enterprise report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/getenterprisereport","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/getenterprisereport","metadata":{"seo":{"title":"Get enterprise report","description":"⚠️ Legacy feature. Android only.Daily and Custom Reports are a legacy feature. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/enterprise-report/"},{"label":"Get group report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/getgroupreport","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/getgroupreport","metadata":{"seo":{"title":"Get group report","description":"⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/group-report/"},{"label":"Get list of subscription reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/getsubscriptionreports","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/getsubscriptionreports","metadata":{"seo":{"title":"Get list of subscription reports","description":"⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/"},{"label":"Post subscription to enterprise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/addsubscription","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/addsubscription","metadata":{"seo":{"title":"Post subscription to enterprise","description":"⚠️ Legacy feature. Android only.Daily and Custom Reports are a legacy feature, and report subscriptions are not part of the current reporting system. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/"},{"label":"Get instance of subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/getsubscriptionreport","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/getsubscriptionreport","metadata":{"seo":{"title":"Get instance of subscription","description":"⚠️ Legacy feature. Android only.Daily and Custom Reports are a legacy feature, and report subscriptions are not part of the current reporting system. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"},{"label":"Update subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/updatesubscriptionreport","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/updatesubscriptionreport","metadata":{"seo":{"title":"Update subscription","description":"⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"},{"label":"Partially update subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/patchsubscriptionreport","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/patchsubscriptionreport","metadata":{"seo":{"title":"Partially update subscription","description":"⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature, and report subscriptions are not part of the current reporting system. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"},{"label":"Deletes instance of subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_daily-and-custom-reports/deletesubscriptionreport","routeSlug":"/openapi/esper_cloud_api_daily-and-custom-reports/deletesubscriptionreport","metadata":{"seo":{"title":"Deletes instance of subscription","description":"⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature, and report subscriptions are not part of the current reporting system. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"}]},{"type":"group","label":"SSO Connections","link":"/openapi/esper_cloud_api_sso-connections","routeSlug":"/openapi/esper_cloud_api_sso-connections","items":[{"label":"List SSO connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_sso-connections/getconnections","routeSlug":"/openapi/esper_cloud_api_sso-connections/getconnections","metadata":{"seo":{"title":"List SSO connections","description":"Lists the SSO connections configured for a tenant. Use it to see every SAML or OIDC identity provider connection set up for the enterprise, along with which one is marked as default."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/connection"},{"label":"Edit SSO connections","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_sso-connections/editcustomconnection","routeSlug":"/openapi/esper_cloud_api_sso-connections/editcustomconnection","metadata":{"seo":{"title":"Edit SSO connections","description":"Updates an existing SSO connection for a tenant, identified by connection_id. Use it to change a connection's display name, strategy, or provider configuration (SAML or OIDC settings) after it's been created."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/connection/{connection_id}"}]},{"type":"group","label":"Roles","link":"/openapi/esper_cloud_api_roles","routeSlug":"/openapi/esper_cloud_api_roles","items":[{"label":"List Roles API","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_roles/getroleurl","routeSlug":"/openapi/esper_cloud_api_roles/getroleurl","metadata":{"seo":{"title":"List Roles API","description":"Returns all custom RBAC roles defined for the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/"},{"label":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_roles/postroleurl","routeSlug":"/openapi/esper_cloud_api_roles/postroleurl","metadata":{"seo":{"title":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default.","description":"Creates a new custom RBAC role for the tenant with a specified name and description."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/"},{"label":"Get Role API","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_roles/getroleidurl","routeSlug":"/openapi/esper_cloud_api_roles/getroleidurl","metadata":{"seo":{"title":"Get Role API","description":"Retrieves the details of a specific custom RBAC role by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}"},{"label":"Patch Role API","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_roles/updateroleidurl","routeSlug":"/openapi/esper_cloud_api_roles/updateroleidurl","metadata":{"seo":{"title":"Patch Role API","description":"Updates the name and/or description of an existing custom RBAC role."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}"},{"label":"Delete Role API","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_roles/deleteroleidurl","routeSlug":"/openapi/esper_cloud_api_roles/deleteroleidurl","metadata":{"seo":{"title":"Delete Role API","description":"Permanently deletes a custom RBAC role from the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}"},{"label":"Update Role Scopes API","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_roles/putrolescopeurl","routeSlug":"/openapi/esper_cloud_api_roles/putrolescopeurl","metadata":{"seo":{"title":"Update Role Scopes API","description":"Replaces the full set of permission scopes assigned to a custom RBAC role."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}/scopes"},{"label":"List Role Scopes API","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_roles/getrolescopeurl","routeSlug":"/openapi/esper_cloud_api_roles/getrolescopeurl","metadata":{"seo":{"title":"List Role Scopes API","description":"Returns the permission scopes currently assigned to a specific custom RBAC role."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}/scopes"}]},{"type":"group","label":"Personal Access Token","link":"/openapi/esper_cloud_api_personal-access-token","routeSlug":"/openapi/esper_cloud_api_personal-access-token","items":[{"label":"Generate a new personal access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/post","routeSlug":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/post","metadata":{"seo":{"title":"Generate a new personal access token","description":"Generates a new personal access token (API key) for the authenticated user, scoped to the current tenant.Use this endpoint to create a named, expiry-controlled API key for programmatic access to the Esper API."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/"},{"label":"Get tokens for corresponding user and tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/get","routeSlug":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/get","metadata":{"seo":{"title":"Get tokens for corresponding user and tenant","description":"Returns the full list of tokens for the current user and tenant. Tokens are scoped to the authenticated caller. This endpoint only returns tokens belonging to the user associated with the API key making the request, not tokens for other users in the tenant. Use this endpoint to locate the id of a specific token for use with the renew (PUT) or delete (DELETE) endpoints."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/"},{"label":"Renew personal access token","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put","routeSlug":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put","metadata":{"seo":{"title":"Renew personal access token","description":"Renews a personal access token by updating its expiry date."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/{personal_access_token_id}"},{"label":"Delete personal access token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete","routeSlug":"/openapi/esper_cloud_api_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete","metadata":{"seo":{"title":"Delete personal access token","description":"Permanently revokes a personal access token (API key), immediately invalidating any API calls that use it."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/{personal_access_token_id}"}]},{"type":"separator","label":"BLUEPRINTS"},{"type":"group","label":"Blueprints API","link":"/openapi/blueprints_blueprints-api","routeSlug":"/openapi/blueprints_blueprints-api","items":[{"label":"/v2/blueprints/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1/get","routeSlug":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1/get","metadata":{"seo":{"title":"/v2/blueprints/","description":"Retrieves a paginated list of all Blueprint V2 blueprints in the enterprise, with optional filtering and sorting.Returns an array of BlueprintV2 objects matching the provided filters; supports filtering by name (case-insensitive or exact), by app or app version IDs across Android, iOS, and Windows, by file or Wi-Fi network references, and by iOS provisioning profile. Results can be ordered by any supported field using the ordering parameter."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/"},{"label":"/v2/blueprints/","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1/post","routeSlug":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1/post","metadata":{"seo":{"title":"/v2/blueprints/","description":"Creates a new blueprint in the enterprise. Blueprints define device configuration and management rules (for example, kiosk/device mode settings, app/file payloads, Wi-Fi networks, and OS-specific restrictions). After you create a blueprint, you can publish versions and then assign/apply it to devices through separate workflows. Creating a blueprint doesn’t affect devices by itself. Devices won’t change until the blueprint (and typically a specific version) is assigned/applied via a separate endpoint/workflow. Because the create response is list-shaped, you should read the new blueprint ID from content.results[0].id. If your workflow relies on versioning, capture both the blueprint id and the returned version_id (if present in your create response), since later calls may require one or the other. Workflow: After creating a bluerprint, assign a device or group to it using POST https://{foo}-api.esper.cloud/api/v2/converge"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/"},{"label":"/v2/blueprints/{blueprint_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/get","routeSlug":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/get","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/","description":"Retrieves the full configuration for a single blueprint by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/"},{"label":"/v2/blueprints/{blueprint_id}/","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/put","routeSlug":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/put","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/","description":"Updates a blueprint's top-level record by ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/"},{"label":"/v2/blueprints/{blueprint_id}/","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/delete","routeSlug":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/delete","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/","description":"Deletes a Blueprint by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/"},{"label":"/v2/blueprints/{blueprint_id}/versions/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get","routeSlug":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/versions/","description":"Retrieves a paginated list of every version created for a specific blueprint."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/versions/"},{"label":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get","routeSlug":"/openapi/blueprints_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","description":"Retrieves the full configuration for a single, specific version of a blueprint."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/versions/{version_id}/"}]},{"type":"group","label":"Custom Actions API","link":"/openapi/blueprints_custom-actions-api","routeSlug":"/openapi/blueprints_custom-actions-api","items":[{"label":"/v2/custom-actions/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1/get","routeSlug":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1/get","metadata":{"seo":{"title":"/v2/custom-actions/","description":"⚠️ Linux only. Custom actions apply exclusively to Linux-managed devices. This endpoint is not applicable to Android, iOS, or Windows devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/"},{"label":"/v2/custom-actions/","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1/post","routeSlug":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1/post","metadata":{"seo":{"title":"/v2/custom-actions/","description":"⚠️ Linux only. Custom actions apply exclusively to Linux-managed devices. This endpoint is not applicable to Android, iOS, or Windows devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/"},{"label":"/v2/custom-actions/{custom_action_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/get","routeSlug":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/get","metadata":{"seo":{"title":"/v2/custom-actions/{custom_action_id}/","description":"⚠️ Linux only. Custom actions apply exclusively to Linux-managed devices. This endpoint is not applicable to Android, iOS, or Windows devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/{custom_action_id}/"},{"label":"/v2/custom-actions/{custom_action_id}/","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/put","routeSlug":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/put","metadata":{"seo":{"title":"/v2/custom-actions/{custom_action_id}/","description":"⚠️ Linux only. Custom actions apply exclusively to Linux-managed devices. This endpoint is not applicable to Android, iOS, or Windows devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/{custom_action_id}/"},{"label":"/v2/custom-actions/{custom_action_id}/","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete","routeSlug":"/openapi/blueprints_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete","metadata":{"seo":{"title":"/v2/custom-actions/{custom_action_id}/","description":"⚠️ Linux only. Custom actions apply exclusively to Linux-managed devices. This endpoint is not applicable to Android, iOS, or Windows devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/{custom_action_id}/"},{"label":"/v2/scripts/{script_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_custom-actions-api/paths/~1v2~1scripts~1{script_id}~1/get","routeSlug":"/openapi/blueprints_custom-actions-api/paths/~1v2~1scripts~1{script_id}~1/get","metadata":{"seo":{"title":"/v2/scripts/{script_id}/","description":"⚠️ Linux only. Scripts retrieved by this endpoint are associated with custom actions that run exclusively on Linux-managed devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/scripts/{script_id}/"}]},{"type":"group","label":"Background Scripts API","link":"/openapi/blueprints_background-scripts-api","routeSlug":"/openapi/blueprints_background-scripts-api","items":[{"label":"/v2/background-scripts/","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_background-scripts-api/paths/~1v2~1background-scripts~1/post","routeSlug":"/openapi/blueprints_background-scripts-api/paths/~1v2~1background-scripts~1/post","metadata":{"seo":{"title":"/v2/background-scripts/","description":"Create a new background script"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/background-scripts/"},{"label":"/v2/background-scripts/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_background-scripts-api/paths/~1v2~1background-scripts~1/get","routeSlug":"/openapi/blueprints_background-scripts-api/paths/~1v2~1background-scripts~1/get","metadata":{"seo":{"title":"/v2/background-scripts/","description":"Retrieve all background scripts for the tenant"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/background-scripts/"},{"label":"/v2/background-scripts/{background_script_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blueprints_background-scripts-api/paths/~1v2~1background-scripts~1{background_script_id}~1/get","routeSlug":"/openapi/blueprints_background-scripts-api/paths/~1v2~1background-scripts~1{background_script_id}~1/get","metadata":{"seo":{"title":"/v2/background-scripts/{background_script_id}/","description":"Retrieve a background script by ID. Includes the script content fetched from S3."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/background-scripts/{background_script_id}/"}]},{"type":"separator","label":"PIPELINES"},{"type":"group","label":"System Status Code","link":"/openapi/pipelines_system-status-code","routeSlug":"/openapi/pipelines_system-status-code","items":[]},{"type":"group","label":"System","link":"/openapi/pipelines_system","routeSlug":"/openapi/pipelines_system","items":[{"label":"Health check endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_system/getservicehealth","routeSlug":"/openapi/pipelines_system/getservicehealth","metadata":{"seo":{"title":"Health check endpoint","description":"Health check endpoint"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/sys/health"}]},{"type":"group","label":"Pipelines","link":"/openapi/pipelines_pipelines","routeSlug":"/openapi/pipelines_pipelines","items":[{"label":"Get all Pipelines for the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipelines/getpipelines","routeSlug":"/openapi/pipelines_pipelines/getpipelines","metadata":{"seo":{"title":"Get all Pipelines for the Enterprise","description":"List all pipelines for the enterprise. Retrieves all active (non-deleted) pipelines configured for the enterprise, including metadata such as name, description, active and validity status, archive state, timeout configuration, and whether the pipeline is set as the default. Results can be filtered by name or sorted alphabetically."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/"},{"label":"Create a new Pipeline","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipelines/createpipeline","routeSlug":"/openapi/pipelines_pipelines/createpipeline","metadata":{"seo":{"title":"Create a new Pipeline","description":"Creates a new Pipeline for the calling enterprise, using the logged-in user's token."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/"},{"label":"Get a Pipeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipelines/getpipeline","routeSlug":"/openapi/pipelines_pipelines/getpipeline","metadata":{"seo":{"title":"Get a Pipeline","description":"Retrieves the details of a single Pipeline by ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/"},{"label":"Update a Pipeline","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipelines/updatepipeline","routeSlug":"/openapi/pipelines_pipelines/updatepipeline","metadata":{"seo":{"title":"Update a Pipeline","description":"Updates an existing Pipeline's configuration."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/"},{"label":"Delete a Pipeline","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipelines/deletepipeline","routeSlug":"/openapi/pipelines_pipelines/deletepipeline","metadata":{"seo":{"title":"Delete a Pipeline","description":"Deletes a Pipeline by ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/"}]},{"type":"group","label":"Stages","link":"/openapi/pipelines_stages","routeSlug":"/openapi/pipelines_stages","items":[{"label":"Get all Pipeline stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/getpipelinestages","routeSlug":"/openapi/pipelines_stages/getpipelinestages","metadata":{"seo":{"title":"Get all Pipeline stages","description":"Retrieves all Stages configured for a Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/"},{"label":"Create a Pipeline stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/createpipelinestage","routeSlug":"/openapi/pipelines_stages/createpipelinestage","metadata":{"seo":{"title":"Create a Pipeline stage","description":"Adds a new Stage to a Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/"},{"label":"Get a Pipeline Stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/getpipelinestage","routeSlug":"/openapi/pipelines_stages/getpipelinestage","metadata":{"seo":{"title":"Get a Pipeline Stage","description":"Retrieves the details of a single Pipeline Stage by ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/"},{"label":"Update a Pipeline Stage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/updatepipelinestage","routeSlug":"/openapi/pipelines_stages/updatepipelinestage","metadata":{"seo":{"title":"Update a Pipeline Stage","description":"Updates the details of an existing Pipeline Stage."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/"},{"label":"Delete a pipeline stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/deletepipelinestage","routeSlug":"/openapi/pipelines_stages/deletepipelinestage","metadata":{"seo":{"title":"Delete a pipeline stage","description":"Deletes a Stage from a Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/"},{"label":"Get all Target Lists attached to the Stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/getstagetargetlists","routeSlug":"/openapi/pipelines_stages/getstagetargetlists","metadata":{"seo":{"title":"Get all Target Lists attached to the Stage","description":"Get all Target Lists attached to the Stage"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/targetlists/"},{"label":"Attach the Target List to the Stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/addstagetargetlist","routeSlug":"/openapi/pipelines_stages/addstagetargetlist","metadata":{"seo":{"title":"Attach the Target List to the Stage","description":"Attach the Target List to the Stage"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/targetlists/"},{"label":"Detach the Target List from the Stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stages/deletestagetargetlist","routeSlug":"/openapi/pipelines_stages/deletestagetargetlist","metadata":{"seo":{"title":"Detach the Target List from the Stage","description":"Detach the Target List from the Stage"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/targetlists/{targetlist_id}/"}]},{"type":"group","label":"Target Lists","link":"/openapi/pipelines_target-lists","routeSlug":"/openapi/pipelines_target-lists","items":[{"label":"Get all Target Lists in Pipeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-lists/getpipelinetargetlists","routeSlug":"/openapi/pipelines_target-lists/getpipelinetargetlists","metadata":{"seo":{"title":"Get all Target Lists in Pipeline","description":"Retrieves all Target Lists defined in a Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/"},{"label":"Create a Target List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-lists/addpipelinetargetlist","routeSlug":"/openapi/pipelines_target-lists/addpipelinetargetlist","metadata":{"seo":{"title":"Create a Target List","description":"Creates a new Target List within a Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/"},{"label":"Get a Pipeline Target list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-lists/getpipelinetargetlist","routeSlug":"/openapi/pipelines_target-lists/getpipelinetargetlist","metadata":{"seo":{"title":"Get a Pipeline Target list","description":"Retrieves the details of a single Target List by ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/"},{"label":"Update a Pipeline Target List","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-lists/updatepipelinetargetlist","routeSlug":"/openapi/pipelines_target-lists/updatepipelinetargetlist","metadata":{"seo":{"title":"Update a Pipeline Target List","description":"Updates the details of an existing Target List."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/"},{"label":"Delete a Pipeline Target list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-lists/deletepipelinetargetlist","routeSlug":"/openapi/pipelines_target-lists/deletepipelinetargetlist","metadata":{"seo":{"title":"Delete a Pipeline Target list","description":"Deletes a Target List from a Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/"}]},{"type":"group","label":"Targets","link":"/openapi/pipelines_targets","routeSlug":"/openapi/pipelines_targets","items":[{"label":"Get all Targets in the Target List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_targets/gettargetlisttargets","routeSlug":"/openapi/pipelines_targets/gettargetlisttargets","metadata":{"seo":{"title":"Get all Targets in the Target List","description":"Get all Targets in the Target List"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/"},{"label":"Create a target for the target list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_targets/createtargetlisttargets","routeSlug":"/openapi/pipelines_targets/createtargetlisttargets","metadata":{"seo":{"title":"Create a target for the target list","description":"Create a target for the target list"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/"},{"label":"Get one target from target list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_targets/gettargetlisttarget","routeSlug":"/openapi/pipelines_targets/gettargetlisttarget","metadata":{"seo":{"title":"Get one target from target list","description":"Get one target from target list"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/"},{"label":"Update a target in the target list","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_targets/updatetargetlisttarget","routeSlug":"/openapi/pipelines_targets/updatetargetlisttarget","metadata":{"seo":{"title":"Update a target in the target list","description":"Update a target in the target list"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/"},{"label":"Delete a Target or Device from a Target List","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_targets/deletetargetlisttarget","routeSlug":"/openapi/pipelines_targets/deletetargetlisttarget","metadata":{"seo":{"title":"Delete a Target or Device from a Target List","description":"Delete a Target or Device from a Target List"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/"},{"label":"Bulk add targets to a target list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_targets/bulkaddtargetlisttargets","routeSlug":"/openapi/pipelines_targets/bulkaddtargetlisttargets","metadata":{"seo":{"title":"Bulk add targets to a target list","description":"Adds multiple targets to a target list. Creates target records if they don't exist, then links them to the target list. Existing targets in the list are left unchanged (skipped). Behaves the same as legacy /targets/ API. device_name should be provided for proper target run creation. device_alias can be provided as a direct property and will be stored in device_meta."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets-bulk/"}]},{"type":"group","label":"Device Groups","link":"/openapi/pipelines_device-groups","routeSlug":"/openapi/pipelines_device-groups","items":[{"label":"Get all Device Groups in the Target List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_device-groups/gettargetlistdevicegroups","routeSlug":"/openapi/pipelines_device-groups/gettargetlistdevicegroups","metadata":{"seo":{"title":"Get all Device Groups in the Target List","description":"Retrieves all Device Groups attached to a Target List."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/"},{"label":"Add a Device Group to the Target List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_device-groups/addtargetlistdevicegroups","routeSlug":"/openapi/pipelines_device-groups/addtargetlistdevicegroups","metadata":{"seo":{"title":"Add a Device Group to the Target List","description":"Add a Device Group to the Target List"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/"},{"label":"Delete Device Group from a Target List","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_device-groups/deletetargetlistdevicegroup","routeSlug":"/openapi/pipelines_device-groups/deletetargetlistdevicegroup","metadata":{"seo":{"title":"Delete Device Group from a Target List","description":"Delete Device Group from a Target List"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{devicegroup_id}/"},{"label":"Get all Devices in the device group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_device-groups/getdevicegroupdevices","routeSlug":"/openapi/pipelines_device-groups/getdevicegroupdevices","metadata":{"seo":{"title":"Get all Devices in the device group","description":"Get all Devices in the device group"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{device_group_id}/devices/"}]},{"type":"group","label":"Operation Lists","link":"/openapi/pipelines_operation-lists","routeSlug":"/openapi/pipelines_operation-lists","items":[{"label":"Get all Operation Lists attached to the Stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operation-lists/getstageoperationlists","routeSlug":"/openapi/pipelines_operation-lists/getstageoperationlists","metadata":{"seo":{"title":"Get all Operation Lists attached to the Stage","description":"Get all Operation Lists attached to the Stage"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/"},{"label":"Create an Operation list for the Stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operation-lists/addstageoperationlist","routeSlug":"/openapi/pipelines_operation-lists/addstageoperationlist","metadata":{"seo":{"title":"Create an Operation list for the Stage","description":"Create an Operation list for the Stage"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/"},{"label":"Update an Operation List","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operation-lists/updatepipelineoperationlist","routeSlug":"/openapi/pipelines_operation-lists/updatepipelineoperationlist","metadata":{"seo":{"title":"Update an Operation List","description":"Update an Operation List"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/"},{"label":"Delete stage operation list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operation-lists/deletestageoperationlist","routeSlug":"/openapi/pipelines_operation-lists/deletestageoperationlist","metadata":{"seo":{"title":"Delete stage operation list","description":"Permanently deletes an Operation List attached to a Pipeline Stage."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/"}]},{"type":"group","label":"Operations","link":"/openapi/pipelines_operations","routeSlug":"/openapi/pipelines_operations","items":[{"label":"Get all Operations in the Operation List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operations/getoperationlistoperations","routeSlug":"/openapi/pipelines_operations/getoperationlistoperations","metadata":{"seo":{"title":"Get all Operations in the Operation List","description":"Returns a paginated list of Operations belonging to a specific Operation List within a Pipeline. Use it to see all the individual operations queued or defined under one Operation List."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/"},{"label":"Create an Operation for Operation List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operations/addoperationlistoperations","routeSlug":"/openapi/pipelines_operations/addoperationlistoperations","metadata":{"seo":{"title":"Create an Operation for Operation List","description":"Adds a new Operation to an existing Operation List in Esper's Pipelines system."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/"},{"label":"Get an Operation from the operation list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operations/getoperationlistoperation","routeSlug":"/openapi/pipelines_operations/getoperationlistoperation","metadata":{"seo":{"title":"Get an Operation from the operation list","description":"Retrieves the details of a single Operation within an Operation List."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/"},{"label":"Update an Operation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operations/updateoperationlistoperation","routeSlug":"/openapi/pipelines_operations/updateoperationlistoperation","metadata":{"seo":{"title":"Update an Operation","description":"Updates an existing Operation in an Operation List."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/"},{"label":"Delete an Operation list operation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_operations/deleteoperationlistoperation","routeSlug":"/openapi/pipelines_operations/deleteoperationlistoperation","metadata":{"seo":{"title":"Delete an Operation list operation","description":"Removes a specific Operation from an Operation List."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/"}]},{"type":"group","label":"Pipeline Runs","link":"/openapi/pipelines_pipeline-runs","routeSlug":"/openapi/pipelines_pipeline-runs","items":[{"label":"Get all Runs for the Pipelines in the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipeline-runs/getallpipelineruns","routeSlug":"/openapi/pipelines_pipeline-runs/getallpipelineruns","metadata":{"seo":{"title":"Get all Runs for the Pipelines in the Enterprise","description":"Get all Runs for the Pipelines in the Enterprise"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/"},{"label":"Get all Runs for the Pipeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipeline-runs/getpipelineruns","routeSlug":"/openapi/pipelines_pipeline-runs/getpipelineruns","metadata":{"seo":{"title":"Get all Runs for the Pipeline","description":"Lists all Pipeline Runs created for a given Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/"},{"label":"Create a Pipeline Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipeline-runs/createpipelinerun","routeSlug":"/openapi/pipelines_pipeline-runs/createpipelinerun","metadata":{"seo":{"title":"Create a Pipeline Run","description":"Triggers a new run of the specified Pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/"},{"label":"Get Pipeline run by pipeline run id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipeline-runs/getpipelinerun","routeSlug":"/openapi/pipelines_pipeline-runs/getpipelinerun","metadata":{"seo":{"title":"Get Pipeline run by pipeline run id","description":"Retrieves the details of a single Pipeline Run."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/"},{"label":"Update a Pipeline Run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipeline-runs/updatepipelinerun","routeSlug":"/openapi/pipelines_pipeline-runs/updatepipelinerun","metadata":{"seo":{"title":"Update a Pipeline Run","description":"Updates a Pipeline Run for a specific pipeline."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/"},{"label":"Delete a Pipeline Run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_pipeline-runs/deletepipelinerun","routeSlug":"/openapi/pipelines_pipeline-runs/deletepipelinerun","metadata":{"seo":{"title":"Delete a Pipeline Run","description":"Deletes a specific Pipeline Run. Only non-running pipelines can be deleted."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/"}]},{"type":"group","label":"Stage Runs","link":"/openapi/pipelines_stage-runs","routeSlug":"/openapi/pipelines_stage-runs","items":[{"label":"Get all Stage Runs for the Pipeline Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stage-runs/getpipelinerunstageruns","routeSlug":"/openapi/pipelines_stage-runs/getpipelinerunstageruns","metadata":{"seo":{"title":"Get all Stage Runs for the Pipeline Run","description":"Get all Stage Runs for the Pipeline Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/"},{"label":"Get Pipeline Stage run by stage run Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stage-runs/getpipelinerunstagerun","routeSlug":"/openapi/pipelines_stage-runs/getpipelinerunstagerun","metadata":{"seo":{"title":"Get Pipeline Stage run by stage run Id","description":"Get Pipeline Stage run by stage run Id"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/"},{"label":"Update a Pipeline Stage Run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stage-runs/updatepipelinerunstagerun","routeSlug":"/openapi/pipelines_stage-runs/updatepipelinerunstagerun","metadata":{"seo":{"title":"Update a Pipeline Stage Run","description":"Update a Pipeline Stage Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/"},{"label":"Get all Operations for the Stage Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stage-runs/getpipelinestagerunoperations","routeSlug":"/openapi/pipelines_stage-runs/getpipelinestagerunoperations","metadata":{"seo":{"title":"Get all Operations for the Stage Run","description":"Get all Operations for the Stage Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/operations/"},{"label":"Get single Operation for the Stage Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_stage-runs/getpipelinestagerunoperation","routeSlug":"/openapi/pipelines_stage-runs/getpipelinestagerunoperation","metadata":{"seo":{"title":"Get single Operation for the Stage Run","description":"Get single Operation for the Stage Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/operations/{stage_run_operation_id}/"}]},{"type":"group","label":"Target Runs","link":"/openapi/pipelines_target-runs","routeSlug":"/openapi/pipelines_target-runs","items":[{"label":"Get all Target Runs for the Stage Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-runs/getpipelinestagetargetruns","routeSlug":"/openapi/pipelines_target-runs/getpipelinestagetargetruns","metadata":{"seo":{"title":"Get all Target Runs for the Stage Run","description":"Get all Target Runs for the Stage Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/"},{"label":"Create a Target Runs for Stage Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-runs/createpipelinestagetargetruns","routeSlug":"/openapi/pipelines_target-runs/createpipelinestagetargetruns","metadata":{"seo":{"title":"Create a Target Runs for Stage Run","description":"Create a Target Runs for Stage Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/"},{"label":"Get Target Run by Target Run ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-runs/getpipelinestagetargetrun","routeSlug":"/openapi/pipelines_target-runs/getpipelinestagetargetrun","metadata":{"seo":{"title":"Get Target Run by Target Run ID","description":"Get Target Run by Target Run ID"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/"},{"label":"Update a Target Run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-runs/updatepipelinestagetargetrun","routeSlug":"/openapi/pipelines_target-runs/updatepipelinestagetargetrun","metadata":{"seo":{"title":"Update a Target Run","description":"Update a Target Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/"},{"label":"Get status of the command running for Target run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-runs/gettargetruncommandstatus","routeSlug":"/openapi/pipelines_target-runs/gettargetruncommandstatus","metadata":{"seo":{"title":"Get status of the command running for Target run","description":"Get status of the command running for Target run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/"},{"label":"Create an command processor request for Target Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-runs/createtargetruncommand","routeSlug":"/openapi/pipelines_target-runs/createtargetruncommand","metadata":{"seo":{"title":"Create an command processor request for Target Run","description":"Create an command processor request for Target Run"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/"},{"label":"Update target run command information.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipelines_target-runs/puttargetruncommandstatus","routeSlug":"/openapi/pipelines_target-runs/puttargetruncommandstatus","metadata":{"seo":{"title":"Update target run command information.","description":"Update target run command information."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/{command_id}/"}]},{"type":"separator","label":"DEVICE"},{"type":"group","label":"Device","link":"/openapi/device_device","routeSlug":"/openapi/device_device","items":[{"label":"Get all devices in the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/getdevicelist","routeSlug":"/openapi/device_device/getdevicelist","metadata":{"seo":{"title":"Get all devices in the tenant","description":"Retrieves a paginated list of all devices enrolled in the tenant across every supported platform."}},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/device/v0/devices/"},{"label":"Get details of a Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/getdevicerequest","routeSlug":"/openapi/device_device/getdevicerequest","metadata":{"seo":{"title":"Get details of a Device","description":"Retrieves the full detail record for a single device by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/device/v0/devices/{id}/"},{"label":"Delete a device. Currently supported by iOS, Linux and Windows devices.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/deletedevicerequest","routeSlug":"/openapi/device_device/deletedevicerequest","metadata":{"seo":{"title":"Delete a device. Currently supported by iOS, Linux and Windows devices.","description":"Permanently deletes a single device record from Esper."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/device/v0/devices/{id}/"},{"label":"Get details of Current Device State","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/getdevicestaterequest","routeSlug":"/openapi/device_device/getdevicestaterequest","metadata":{"seo":{"title":"Get details of Current Device State","description":"Retrieves the current settings and state snapshot for a single device."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/device/v0/devices/{id}/devicestate"},{"label":"Receive device state report and publish to Kafka for drift detection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/updatedevicestate","routeSlug":"/openapi/device_device/updatedevicestate","metadata":{"seo":{"title":"Receive device state report and publish to Kafka for drift detection","description":"Accepts a device state report and forwards it (as-is) to Kafka topic esper.device.device.state after enriching with tenant_id and device_id."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{id}/devicestate"},{"label":"Get all devices in the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/paths/~1v2~1devices~1/get","routeSlug":"/openapi/device_device/paths/~1v2~1devices~1/get","metadata":{"seo":{"title":"Get all devices in the tenant","description":"Retrieves a paginated list of all devices enrolled in the tenant, across all platforms, using the V2 device schema."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/"},{"label":"Retrieve detailed device information.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/paths/~1v2~1devices~1{id}/get","routeSlug":"/openapi/device_device/paths/~1v2~1devices~1{id}/get","metadata":{"seo":{"title":"Retrieve detailed device information.","description":"Retrieves comprehensive details for a single enrolled device by UUID, using the V2 device schema."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{id}"},{"label":"Update tags associated with a device.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/paths/~1v2~1devices~1{id}~1tags~1/put","routeSlug":"/openapi/device_device/paths/~1v2~1devices~1{id}~1tags~1/put","metadata":{"seo":{"title":"Update tags associated with a device.","description":"Associates and Removes tags on a single enrolled Apple, Linux or Windows device by UUID. Tag changes are applied incrementally via add and remove arrays."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{id}/tags/"},{"label":"Get all distinct foundation versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device/getfoundationversionslist","routeSlug":"/openapi/device_device/getfoundationversionslist","metadata":{"seo":{"title":"Get all distinct foundation versions","description":"Returns a list of distinct foundation versions present in the tenant's devices"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/foundationversions"}]},{"type":"group","label":"Device Heartbeat","link":"/openapi/device_device-heartbeat","routeSlug":"/openapi/device_device-heartbeat","items":[{"label":"Get heartbeat of a device which contains last seen information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-heartbeat/getdeviceheartbeat","routeSlug":"/openapi/device_device-heartbeat/getdeviceheartbeat","metadata":{"seo":{"title":"Get heartbeat of a device which contains last seen information","description":"Retrieves the last-seen heartbeat record for a single device, including its most recent check-in timestamp."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/device/v0/heartbeat/{id}/"},{"label":"Get list of heartbeat for all devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-heartbeat/getdeviceheartbeatlist","routeSlug":"/openapi/device_device-heartbeat/getdeviceheartbeatlist","metadata":{"seo":{"title":"Get list of heartbeat for all devices","description":"Retrieves heartbeat records for all devices whose last-seen timestamp falls within a specified date-time range."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/heartbeat/"}]},{"type":"group","label":"Device Apps","link":"/openapi/device_device-apps","routeSlug":"/openapi/device_device-apps","items":[{"label":"Get all apps for a device in the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-apps/paths/~1v2~1devices~1{deviceid}~1device-apps~1/get","routeSlug":"/openapi/device_device-apps/paths/~1v2~1devices~1{deviceid}~1device-apps~1/get","metadata":{"seo":{"title":"Get all apps for a device in the tenant","description":"Retrieves a paginated list of every app installed on a specific device."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/device-apps/"},{"label":"Get list of devices with an app by app_id or app_version_id.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-apps/paths/~1v2~1device-apps/get","routeSlug":"/openapi/device_device-apps/paths/~1v2~1device-apps/get","metadata":{"seo":{"title":"Get list of devices with an app by app_id or app_version_id.","description":"iOS/iPadOS/tvOS/Windows only"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/device-apps"}]},{"type":"group","label":"Device Enrollment in EMM","link":"/openapi/device_device-enrollment-in-emm","routeSlug":"/openapi/device_device-enrollment-in-emm","items":[{"label":"Get the Google EMM Policy details for a specific device.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/get","routeSlug":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/get","metadata":{"seo":{"title":"Get the Google EMM Policy details for a specific device.","description":"Get the Google EMM Policy details for a specific device."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/google-accounts/policy/"},{"label":"Update the Google EMM Policy details for a specific device.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/put","routeSlug":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/put","metadata":{"seo":{"title":"Update the Google EMM Policy details for a specific device.","description":"Update the Google EMM Policy details for a specific device."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/google-accounts/policy/"},{"label":"Get the List of Google EMM Managed Devices for a user's devices.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1emm-managed~1/get","routeSlug":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1emm-managed~1/get","metadata":{"seo":{"title":"Get the List of Google EMM Managed Devices for a user's devices.","description":"Get the List of Google EMM Managed Devices for a user's devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/google-accounts/emm-managed/"},{"label":"Return the Google account details of the EMM enrollment stored in the database for the specified device.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/get","routeSlug":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/get","metadata":{"seo":{"title":"Return the Google account details of the EMM enrollment stored in the database for the specified device.","description":"Return the Google account details of the EMM enrollment stored in the database for the specified device."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/google-accounts/"},{"label":"Update the Google account details of the EMM enrollment stored in the database for a specific device.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/put","routeSlug":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/put","metadata":{"seo":{"title":"Update the Google account details of the EMM enrollment stored in the database for a specific device.","description":"Update the Google account details of the EMM enrollment stored in the database for a specific device."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/google-accounts/"},{"label":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/post","routeSlug":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/post","metadata":{"seo":{"title":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side.","description":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/google-accounts/"},{"label":"Unenrolls device from Google EMM and deletes the Google account details.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/delete","routeSlug":"/openapi/device_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/delete","metadata":{"seo":{"title":"Unenrolls device from Google EMM and deletes the Google account details.","description":"Unenrolls a device from Google EMM and deletes its stored Google account details."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/devices/{deviceId}/google-accounts/"}]},{"type":"group","label":"Operations","link":"/openapi/device_operations","routeSlug":"/openapi/device_operations","items":[{"label":"Get all Operations in the Tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_operations/getoperationslist","routeSlug":"/openapi/device_operations/getoperationslist","metadata":{"seo":{"title":"Get all Operations in the Tenant","description":"Retrieves a paginated list of all Dispatch operations created within the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/operations/"},{"label":"Create a new Operation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_operations/createoperation","routeSlug":"/openapi/device_operations/createoperation","metadata":{"seo":{"title":"Create a new Operation","description":"Creates a new Dispatch operation to run a large fleet action, such as Converge, across a set of devices or groups in a single request."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/operations/"},{"label":"Get specific Operation details (Operation Status)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_operations/getoperation","routeSlug":"/openapi/device_operations/getoperation","metadata":{"seo":{"title":"Get specific Operation details (Operation Status)","description":"Retrieves the full status and aggregate device counts for a single Dispatch operation."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/operations/{operationId}/"},{"label":"Update the operation (Support status update as of now)","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_operations/paths/~1v0~1operations~1{operationid}~1/put","routeSlug":"/openapi/device_operations/paths/~1v0~1operations~1{operationid}~1/put","metadata":{"seo":{"title":"Update the operation (Support status update as of now)","description":"Updates the status of an existing Dispatch operation. Supports CANCEL only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/operations/{operationId}/"}]},{"type":"group","label":"DeviceOperations","link":"/openapi/device_deviceoperations","routeSlug":"/openapi/device_deviceoperations","items":[{"label":"Get all DeviceOperations for a specific Operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_deviceoperations/getdeviceoperations","routeSlug":"/openapi/device_deviceoperations/getdeviceoperations","metadata":{"seo":{"title":"Get all DeviceOperations for a specific Operation","description":"Retrieves the per-device breakdown of a single Dispatch operation, showing where every targeted device stands in the operation's lifecycle."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/operations/{operationsId}/devices/"},{"label":"Get a Operations for a device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_deviceoperations/paths/~1v0~1devices~1{deviceid}~1operations~1/get","routeSlug":"/openapi/device_deviceoperations/paths/~1v0~1devices~1{deviceid}~1operations~1/get","metadata":{"seo":{"title":"Get a Operations for a device","description":"Retrieves the Dispatch operations that have targeted a specific device, giving a device-centric view of Converge, install, and uninstall activity."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/devices/{deviceId}/operations/"},{"label":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_deviceoperations/getdeviceoperation","routeSlug":"/openapi/device_deviceoperations/getdeviceoperation","metadata":{"seo":{"title":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)","description":"Retrieves the status of a single device's progress within a specific Dispatch operation."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/operations/{operationsId}/devices/{deviceId}/"},{"label":"Update a specific DeviceOperation for a specific Operation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_deviceoperations/updatedeviceoperation","routeSlug":"/openapi/device_deviceoperations/updatedeviceoperation","metadata":{"seo":{"title":"Update a specific DeviceOperation for a specific Operation","description":"Updates the recorded state of a single device's progress within a Dispatch operation."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/operations/{operationsId}/devices/{deviceId}/"}]},{"type":"group","label":"MultiOS Remote Viewer","link":"/openapi/device_multios-remote-viewer","routeSlug":"/openapi/device_multios-remote-viewer","items":[{"label":"Get RemoteViewer Activity Feed for the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_multios-remote-viewer/paths/~1v2~1rv-activity-feed~1/get","routeSlug":"/openapi/device_multios-remote-viewer/paths/~1v2~1rv-activity-feed~1/get","metadata":{"seo":{"title":"Get RemoteViewer Activity Feed for the tenant","description":"Retrieves a paginated, filterable feed of Remote Viewer sessions across the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/rv-activity-feed/"}]},{"type":"separator","label":"APPS MANAGEMENT"},{"type":"group","label":"VPP License Management","link":"/openapi/apps_management_vpp-license-management","routeSlug":"/openapi/apps_management_vpp-license-management","items":[{"label":"Get VPP License List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_vpp-license-management/paths/~1apps~1v0~1vpp/get","routeSlug":"/openapi/apps_management_vpp-license-management/paths/~1apps~1v0~1vpp/get","metadata":{"seo":{"title":"Get VPP License List","description":"Returns a paginated list of VPP (Volume Purchase Program) licenses associated with the tenant's configured VPP token. Use it to see all Apple VPP-licensed apps and their license counts in one call."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/apps/v0/vpp"},{"label":"Get VPP License Info about an App","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_vpp-license-management/paths/~1apps~1v0~1vpp~1{appid}/get","routeSlug":"/openapi/apps_management_vpp-license-management/paths/~1apps~1v0~1vpp~1{appid}/get","metadata":{"seo":{"title":"Get VPP License Info about an App","description":"Returns VPP (Volume Purchase Program) license details for a single app, identified by its VPP app ID. Use it to check license status and counts for one specific iOS app rather than pulling the full license list."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/apps/v0/vpp/{appId}"}]},{"type":"group","label":"VPP App Management","link":"/openapi/apps_management_vpp-app-management","routeSlug":"/openapi/apps_management_vpp-app-management","items":[{"label":"Get iOS App Info (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_vpp-app-management/paths/~1v2~1itunesapps/get","routeSlug":"/openapi/apps_management_vpp-app-management/paths/~1v2~1itunesapps/get","metadata":{"seo":{"title":"Get iOS App Info (v2)","description":"Looks up iOS app information by app ID or Apple app ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/itunesapps"},{"label":"Set Preferred Region for VPP App","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_vpp-app-management/paths/~1v2~1itunesapps~1{appleappid}~1preferred-region/put","routeSlug":"/openapi/apps_management_vpp-app-management/paths/~1v2~1itunesapps~1{appleappid}~1preferred-region/put","metadata":{"seo":{"title":"Set Preferred Region for VPP App","description":"⚠️ Apple devices only. This endpoint applies exclusively to iOS devices managed via VPP (Volume Purchase Program)."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/itunesapps/{appleAppId}/preferred-region"},{"label":"Force refresh of VPP app version metadata","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_vpp-app-management/paths/~1v2~1itunesapps~1{appid}~1refresh-version/post","routeSlug":"/openapi/apps_management_vpp-app-management/paths/~1v2~1itunesapps~1{appid}~1refresh-version/post","metadata":{"seo":{"title":"Force refresh of VPP app version metadata","description":"Forces an on-demand refresh of a single VPP app's iTunes version metadata."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/itunesapps/{appId}/refresh-version"}]},{"type":"group","label":"Tenant Apps","link":"/openapi/apps_management_tenant-apps","routeSlug":"/openapi/apps_management_tenant-apps","items":[{"label":"Upload tenant app for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps/post","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps/post","metadata":{"seo":{"title":"Upload tenant app for a tenant","description":"Uploads a new iOS or Windows app file to the tenant's app catalog."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps"},{"label":"Get tenant apps for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps/get","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps/get","metadata":{"seo":{"title":"Get tenant apps for a tenant","description":"Retrieves a paginated list of all tenant-uploaded apps for iOS and Windows devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps"},{"label":"Get tenant app by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}/get","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}/get","metadata":{"seo":{"title":"Get tenant app by ID","description":"Retrieves a single tenant app's detail record by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps/{appId}"},{"label":"Get tenant app versions by app ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions/get","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions/get","metadata":{"seo":{"title":"Get tenant app versions by app ID","description":"Retrieves a paginated list of every version uploaded for a specific tenant app."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps/{appId}/versions"},{"label":"Get tenant app version by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/get","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/get","metadata":{"seo":{"title":"Get tenant app version by ID","description":"Retrieves the full detail record for a single tenant app version."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}"},{"label":"Update tenant app version by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/put","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/put","metadata":{"seo":{"title":"Update tenant app version by ID","description":"Updates the description field on a specific tenant app version."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}"},{"label":"Delete tenant app version by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/delete","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/delete","metadata":{"seo":{"title":"Delete tenant app version by ID","description":"Permanently deletes a single version of a tenant-uploaded iOS or Windows app."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}"},{"label":"Add an artifact to a UWP app version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}~1artifacts/post","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}~1artifacts/post","metadata":{"seo":{"title":"Add an artifact to a UWP app version","description":"Uploads a per-version artifact (a UWP framework dependency or signingcertificate) for a TENANT_WINDOWS_UWP app version."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}/artifacts"},{"label":"Delete an artifact from a UWP app version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}~1artifacts~1{artifactid}/delete","routeSlug":"/openapi/apps_management_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}~1artifacts~1{artifactid}/delete","metadata":{"seo":{"title":"Delete an artifact from a UWP app version","description":"Deletes a per-version artifact (dependency or certificate) by its id, removing both its stored file and its record."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}/artifacts/{artifactId}"}]},{"type":"group","label":"Apple App Store","link":"/openapi/apps_management_apple-app-store","routeSlug":"/openapi/apps_management_apple-app-store","items":[{"label":"Search Apple App Store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_apple-app-store/paths/~1v2~1appleappstore~1/get","routeSlug":"/openapi/apps_management_apple-app-store/paths/~1v2~1appleappstore~1/get","metadata":{"seo":{"title":"Search Apple App Store","description":"⚠️ Apple devices only. This endpoint searches Apple's App Store for apps available for deployment to Apple-managed devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/appleappstore/"}]},{"type":"group","label":"App List","link":"/openapi/apps_management_app-list","routeSlug":"/openapi/apps_management_app-list","items":[{"label":"Get unified list of iOS apps (IPAs and Webclips) for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_app-list/paths/~1v2~1apps/get","routeSlug":"/openapi/apps_management_app-list/paths/~1v2~1apps/get","metadata":{"seo":{"title":"Get unified list of iOS apps (IPAs and Webclips) for a tenant","description":"⚠️ Apple devices and Windows only. This endpoint returns Window or iOS app records only. Android apps use the Application V1 API (https://api.esper.io/openapi/esper_cloud_api_application-v1).Retrieves a unified, paginated list of all iOS and Windows apps in the tenant library, spanning MSI, IPA-based tenant apps, and webclips, in a single normalized view."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/apps"}]},{"type":"group","label":"Webclips","link":"/openapi/apps_management_webclips","routeSlug":"/openapi/apps_management_webclips","items":[{"label":"Create webclip for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_webclips/paths/~1v2~1webclips/post","routeSlug":"/openapi/apps_management_webclips/paths/~1v2~1webclips/post","metadata":{"seo":{"title":"Create webclip for a tenant","description":"⚠️ iOS/iPadOS only. Webclips are home screen shortcuts for iOS and iPadOS managed devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/webclips"},{"label":"Get webclips for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_webclips/paths/~1v2~1webclips/get","routeSlug":"/openapi/apps_management_webclips/paths/~1v2~1webclips/get","metadata":{"seo":{"title":"Get webclips for a tenant","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/webclips"},{"label":"Get webclip by id for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_webclips/paths/~1v2~1webclips~1{webclipid}/get","routeSlug":"/openapi/apps_management_webclips/paths/~1v2~1webclips~1{webclipid}/get","metadata":{"seo":{"title":"Get webclip by id for a tenant","description":"⚠️ iOS/iPadOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/webclips/{webclipId}"},{"label":"Delete webclip for a tenant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_webclips/paths/~1v2~1webclips~1{webclipid}/delete","routeSlug":"/openapi/apps_management_webclips/paths/~1v2~1webclips~1{webclipid}/delete","metadata":{"seo":{"title":"Delete webclip for a tenant","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/webclips/{webclipId}"}]},{"type":"group","label":"Provisioning Profiles","link":"/openapi/apps_management_provisioning-profiles","routeSlug":"/openapi/apps_management_provisioning-profiles","items":[{"label":"Upload provisioning profile for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles/post","routeSlug":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles/post","metadata":{"seo":{"title":"Upload provisioning profile for a tenant","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/provisioning-profiles"},{"label":"Get provisioning profiles for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles/get","routeSlug":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles/get","metadata":{"seo":{"title":"Get provisioning profiles for a tenant","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/provisioning-profiles"},{"label":"Get provisioning profile by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}/get","routeSlug":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}/get","metadata":{"seo":{"title":"Get provisioning profile by ID","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/provisioning-profiles/{id}"},{"label":"Get provisioning profile versions list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions/get","routeSlug":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions/get","metadata":{"seo":{"title":"Get provisioning profile versions list","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/provisioning-profiles/{id}/versions"},{"label":"Get provisioning profile version by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/get","routeSlug":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/get","metadata":{"seo":{"title":"Get provisioning profile version by ID","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/provisioning-profiles/{id}/versions/{versionId}"},{"label":"Delete provisioning profile version by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/delete","routeSlug":"/openapi/apps_management_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/delete","metadata":{"seo":{"title":"Delete provisioning profile version by ID","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/provisioning-profiles/{id}/versions/{versionId}"}]},{"type":"group","label":"Preferred Regions","link":"/openapi/apps_management_preferred-regions","routeSlug":"/openapi/apps_management_preferred-regions","items":[{"label":"Set Preferred Regions for Tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_preferred-regions/paths/~1v2~1preferred-regions/post","routeSlug":"/openapi/apps_management_preferred-regions/paths/~1v2~1preferred-regions/post","metadata":{"seo":{"title":"Set Preferred Regions for Tenant","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/preferred-regions"},{"label":"Get Preferred Regions for Tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_preferred-regions/paths/~1v2~1preferred-regions/get","routeSlug":"/openapi/apps_management_preferred-regions/paths/~1v2~1preferred-regions/get","metadata":{"seo":{"title":"Get Preferred Regions for Tenant","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/preferred-regions"}]},{"type":"group","label":"OEM Config Schema","link":"/openapi/apps_management_oem-config-schema","routeSlug":"/openapi/apps_management_oem-config-schema","items":[{"label":"Get OEM Config Schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_oem-config-schema/getoemconfigschema","routeSlug":"/openapi/apps_management_oem-config-schema/getoemconfigschema","metadata":{"seo":{"title":"Get OEM Config Schema","description":"Retrieves the OEM config schema for a given OEM type and app package name. Use it to get the structure that describes which OEM-specific managed configuration keys an app supports and how they're formatted."}},"badges":[{"name":"Beta","color":"yellow"}],"httpPath":"/v2/oem-config-schema"}]},{"type":"group","label":"Esper Apps","link":"/openapi/apps_management_esper-apps","routeSlug":"/openapi/apps_management_esper-apps","items":[{"label":"Get esper app version details by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_esper-apps/paths/~1v2~1esper-apps~1{appid}~1versions~1{versionid}/get","routeSlug":"/openapi/apps_management_esper-apps/paths/~1v2~1esper-apps~1{appid}~1versions~1{versionid}/get","metadata":{"seo":{"title":"Get esper app version details by ID","description":"Retrieves details for a specific version of an Esper App."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/esper-apps/{appId}/versions/{versionId}"}]},{"type":"group","label":"Tenant Esper Apps","link":"/openapi/apps_management_tenant-esper-apps","routeSlug":"/openapi/apps_management_tenant-esper-apps","items":[{"label":"Get esper apps for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/apps_management_tenant-esper-apps/paths/~1v2~1tenant-esper-apps/get","routeSlug":"/openapi/apps_management_tenant-esper-apps/paths/~1v2~1tenant-esper-apps/get","metadata":{"seo":{"title":"Get esper apps for a tenant","description":"Retrieves a paginated list of Esper-provided apps available to the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/tenant-esper-apps"}]},{"type":"separator","label":"COMMANDS"},{"type":"group","label":"Command Request","link":"/openapi/commands_command-request","routeSlug":"/openapi/commands_command-request","items":[{"label":"List command requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-request/listcommandrequests","routeSlug":"/openapi/commands_command-request/listcommandrequests","metadata":{"seo":{"title":"List command requests","description":"Returns a paginated list of command requests within the enterprise. Each record includes the command type, targeted devices or groups, schedule details, arguments, and current status. This endpoint provides visibility into commands that have been issued, whether they are queued, in progress, successful, or failed. Common use cases: Auditing commands sent across the enterprise Tracking scheduled vs immediate commands Reviewing historical command activity Troubleshooting command execution at scale Best Practices: Use pagination parameters to manage large datasets. Filter or search (if supported) to narrow results when investigating specific command IDs or timeframes. For device-level execution results, pair this endpoint with command status or event feed views."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/commands/v0/commands/"},{"label":"Create a command request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-request/createcommandrequest","routeSlug":"/openapi/commands_command-request/createcommandrequest","metadata":{"seo":{"title":"Create a command request","description":"Issues a device or group-level command using the stable command API. This endpoint supports multi-OS environments and scheduling options, and should be used for all new command integrations. Common use cases: Installing or uninstalling apps, pushing certificates, modifying device settings, sending notifications, enforcing policies, and other device actions supported by Esper. Best Practices: Ensure the command is supported for the device’s OS before sending. Decide whether to target specific devices (DEVICE) or a device group (GROUP). Determine whether the command should run IMMEDIATE or use scheduling options (if supported by the command). Validate command_args carefully—payload structure differs by command. Understand the command lifecycle (queued → acknowledged → in progress → success/failure). Monitor execution and final state in the Event Feed after issuing the request. Important: Response bodies can vary depending on the command. For detailed examples and command-specific payload guidance, refer to the API Commands help documentation: https://help.esper.io/hc/en-us/articles/29710806069393-Creating-API-Commands"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/commands/v0/commands/"},{"label":"Get a command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-request/getcommandrequest","routeSlug":"/openapi/commands_command-request/getcommandrequest","metadata":{"seo":{"title":"Get a command request","description":"Retrieves a single command request by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/commands/v0/commands/{id}/"},{"label":"Get stats of a command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-request/getcommandrequeststats","routeSlug":"/openapi/commands_command-request/getcommandrequeststats","metadata":{"seo":{"title":"Get stats of a command request","description":"Retrieves an aggregated count of devices in each status for a given command request."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/commands/v0/commands/{id}/stats/"}]},{"type":"group","label":"Command Status","link":"/openapi/commands_command-status","routeSlug":"/openapi/commands_command-status","items":[{"label":"Get status list for command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-status/getcommandrequeststatuses","routeSlug":"/openapi/commands_command-status/getcommandrequeststatuses","metadata":{"seo":{"title":"Get status list for command request","description":"Retrieves a paginated, filterable list of individual command status records across the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/commands/v0/status/"},{"label":"Get a command status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-status/getcommandstatus","routeSlug":"/openapi/commands_command-status/getcommandstatus","metadata":{"seo":{"title":"Get a command status","description":"Retrieves a single command status record by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/commands/v0/status/{id}/"},{"label":"Update command status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-status/updatecommandstatus","routeSlug":"/openapi/commands_command-status/updatecommandstatus","metadata":{"seo":{"title":"Update command status","description":"Updates the state of an individual command status record. Supports only CANCEL. Cancellations are not always guaranteed and depends on the command's exact state."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/commands/v0/status/{id}/"},{"label":"Get queued commands to be executed by the physical device.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/commands_command-status/getcommandinbox","routeSlug":"/openapi/commands_command-status/getcommandinbox","metadata":{"seo":{"title":"Get queued commands to be executed by the physical device.","description":"Retrieves the commands currently queued for a specific device to execute."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/command-inbox/"}]},{"type":"separator","label":"DRIFT"},{"type":"group","label":"Converge","link":"/openapi/drift_converge","routeSlug":"/openapi/drift_converge","items":[{"label":"List converge action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/drift_converge/listconverges","routeSlug":"/openapi/drift_converge/listconverges","metadata":{"seo":{"title":"List converge action","description":"Retrieves a paginated list of Converge actions issued in the tenant."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/converge"},{"label":"Create a converge action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/drift_converge/createconverge","routeSlug":"/openapi/drift_converge/createconverge","metadata":{"seo":{"title":"Create a converge action","description":"POST converge (V2). Assigns a device to a specific blueprint (and blueprint version) and triggers the converge workflow. Converge brings the device into alignment with the selected blueprint configuration, including apps, files, restrictions, and platform settings. What this endpoint does Assigns the device to the provided blueprint_id. Targets a specific blueprint_version_id. Queues a converge action (status: QUEUED) for execution. Optionally applies provisioning-related behavior via converge_with_provision_option. Workflow Use Get all blueprints (V2) to retrieve the desired blueprint_id and blueprint_version_id. Use a device listing endpoint to retrieve the device_id or group_id. Send a POST request to /api/v2/converge with the required identifiers. Monitor the converge/command status to confirm successful application."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/converge"},{"label":"Get converge action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/drift_converge/getconverge","routeSlug":"/openapi/drift_converge/getconverge","metadata":{"seo":{"title":"Get converge action","description":"Retrieves the full detail of a single Converge action by its ID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/converge/{id}"}]},{"type":"group","label":"Converge Command","link":"/openapi/drift_converge-command","routeSlug":"/openapi/drift_converge-command","items":[{"label":"List commands fires for converge action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/drift_converge-command/listconvergecommands","routeSlug":"/openapi/drift_converge-command/listconvergecommands","metadata":{"seo":{"title":"List commands fires for converge action","description":"Retrieves the underlying commands that were fired to carry out a specific Converge action."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/converge/{id}/commands"}]},{"type":"group","label":"Blueprint Drift","link":"/openapi/drift_blueprint-drift","routeSlug":"/openapi/drift_blueprint-drift","items":[{"label":"Fetch Blueprint Drift summary counts for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/drift_blueprint-drift/getblueprintdriftsummary","routeSlug":"/openapi/drift_blueprint-drift/getblueprintdriftsummary","metadata":{"seo":{"title":"Fetch Blueprint Drift summary counts for a tenant","description":"Fetch Blueprint Drift summary counts for a tenant."}},"httpPath":"/v2/blueprint-drift/summary"},{"label":"Fetch Blueprint Drift status for devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/drift_blueprint-drift/getblueprintdriftstatus","routeSlug":"/openapi/drift_blueprint-drift/getblueprintdriftstatus","metadata":{"seo":{"title":"Fetch Blueprint Drift status for devices","description":"Fetch Blueprint Drift status for a set of devices."}},"httpPath":"/v2/blueprint-drift/status"},{"label":"Fetch per-setting Blueprint Drift Audit for a device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/drift_blueprint-drift/getdeviceblueprintdriftsettings","routeSlug":"/openapi/drift_blueprint-drift/getdeviceblueprintdriftsettings","metadata":{"seo":{"title":"Fetch per-setting Blueprint Drift Audit for a device","description":"Fetch per-setting Blueprint Drift Audit for a single device."}},"httpPath":"/v2/blueprint-drift/{deviceId}/status"}]},{"type":"separator","label":"DEVICE ONBOARDING"},{"type":"group","label":"DEP Sync Request","link":"/openapi/device_onboarding_dep-sync-request","routeSlug":"/openapi/device_onboarding_dep-sync-request","items":[{"label":"List all DEP sync requests for the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_onboarding_dep-sync-request/listdepsyncrequest","routeSlug":"/openapi/device_onboarding_dep-sync-request/listdepsyncrequest","metadata":{"seo":{"title":"List all DEP sync requests for the tenant","description":"⚠️ Apple devices only. DEP (Device Enrollment Program) is an Apple provisioning technology, now part of Apple Business Manager."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/onboarding/v0/depsyncs/"},{"label":"Create a DEP sync request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_onboarding_dep-sync-request/createdepsyncrequest","routeSlug":"/openapi/device_onboarding_dep-sync-request/createdepsyncrequest","metadata":{"seo":{"title":"Create a DEP sync request","description":"⚠️ Apple devices only. DEP (Device Enrollment Program) is an Apple provisioning technology, now part of Apple Business Manager."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/onboarding/v0/depsyncs/"},{"label":"Get a DEP sync request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_onboarding_dep-sync-request/getdepsyncrequest","routeSlug":"/openapi/device_onboarding_dep-sync-request/getdepsyncrequest","metadata":{"seo":{"title":"Get a DEP sync request","description":"⚠️ Apple devices only. DEP (Device Enrollment Program) is an Apple provisioning technology, now part of Apple Business Manager."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/onboarding/v0/depsyncs/{id}/"}]},{"type":"group","label":"ABM Provisioning","link":"/openapi/device_onboarding_abm-provisioning","routeSlug":"/openapi/device_onboarding_abm-provisioning","items":[{"label":"Create a ABM provisioning request by uploading file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_onboarding_abm-provisioning/paths/~1v2~1seamless~1upload/post","routeSlug":"/openapi/device_onboarding_abm-provisioning/paths/~1v2~1seamless~1upload/post","metadata":{"seo":{"title":"Create a ABM provisioning request by uploading file","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/seamless/upload"},{"label":"Create a ABM provisioning request using device serial number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/device_onboarding_abm-provisioning/paths/~1v2~1seamless/post","routeSlug":"/openapi/device_onboarding_abm-provisioning/paths/~1v2~1seamless/post","metadata":{"seo":{"title":"Create a ABM provisioning request using device serial number","description":"⚠️ Apple devices only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/seamless"}]},{"type":"separator","label":"TENANT"},{"type":"group","label":"APNs certificate","link":"/openapi/tenant_apns-certificate","routeSlug":"/openapi/tenant_apns-certificate","items":[{"label":"Get all APNs certificate meta data for the Tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_apns-certificate/listapnscerts","routeSlug":"/openapi/tenant_apns-certificate/listapnscerts","metadata":{"seo":{"title":"Get all APNs certificate meta data for the Tenant","description":"⚠️ iOS/iPadOS/tvOS only. APNs (Apple Push Notification service) certificates are required for Esper to communicate with and manage Apple devices."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/apnscertificates/"},{"label":"Get the CSR file to upload to the apple identity console","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_apns-certificate/getapnscsr","routeSlug":"/openapi/tenant_apns-certificate/getapnscsr","metadata":{"seo":{"title":"Get the CSR file to upload to the apple identity console","description":"⚠️ iOS/iPadOS/tvOS only. This is step 1 of the APNs certificate setup workflow."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/apnscertificates/"},{"label":"Get APNs certificate meta information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_apns-certificate/getapnscert","routeSlug":"/openapi/tenant_apns-certificate/getapnscert","metadata":{"seo":{"title":"Get APNs certificate meta information","description":"⚠️ iOS/iPadOS/tvOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/apnscertificates/{id}/"},{"label":"Upload APNs certificate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_apns-certificate/uploadapnscert","routeSlug":"/openapi/tenant_apns-certificate/uploadapnscert","metadata":{"seo":{"title":"Upload APNs certificate","description":"⚠️ iOS/iPadOS/tvOS only. This is step 3 of the APNs certificate setup workflow."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/apnscertificates/{id}/"},{"label":"Delete a APNs certificate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_apns-certificate/deleteapnscert","routeSlug":"/openapi/tenant_apns-certificate/deleteapnscert","metadata":{"seo":{"title":"Delete a APNs certificate","description":"⚠️ iOS/iPadOS/tvOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/apnscertificates/{id}/"}]},{"type":"group","label":"DEP Profile","link":"/openapi/tenant_dep-profile","routeSlug":"/openapi/tenant_dep-profile","items":[{"label":"Get all DEP profiles for the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_dep-profile/getdepprofilelist","routeSlug":"/openapi/tenant_dep-profile/getdepprofilelist","metadata":{"seo":{"title":"Get all DEP profiles for the tenant","description":"Returns all the DEP profile for the tenant"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/depprofiles/"},{"label":"Create a DEP profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_dep-profile/createdepprofile","routeSlug":"/openapi/tenant_dep-profile/createdepprofile","metadata":{"seo":{"title":"Create a DEP profile","description":"Creates a DEP profile"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/depprofiles/"}]},{"type":"group","label":"DEP Tokens","link":"/openapi/tenant_dep-tokens","routeSlug":"/openapi/tenant_dep-tokens","items":[{"label":"Generate the public key file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_dep-tokens/deptoken","routeSlug":"/openapi/tenant_dep-tokens/deptoken","metadata":{"seo":{"title":"Generate the public key file","description":"⚠️ iOS/iPadOS/tvOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/deptokens/"},{"label":"Get all DEP tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_dep-tokens/listdeptokens","routeSlug":"/openapi/tenant_dep-tokens/listdeptokens","metadata":{"seo":{"title":"Get all DEP tokens","description":"⚠️ iOS/iPadOS/tvOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/deptokens/"},{"label":"Get dep token by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_dep-tokens/deptokenbasedonid","routeSlug":"/openapi/tenant_dep-tokens/deptokenbasedonid","metadata":{"seo":{"title":"Get dep token by id","description":"Retrieves the details of a single DEP token by its UUID."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/deptokens/{id}/"},{"label":"Upload dep token to a tenant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_dep-tokens/deptokenupload","routeSlug":"/openapi/tenant_dep-tokens/deptokenupload","metadata":{"seo":{"title":"Upload dep token to a tenant","description":"Upload dep token for a public key for a tenant based on ID of DEP public key"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/deptokens/{id}/"}]},{"type":"group","label":"VPP Token Management","link":"/openapi/tenant_vpp-token-management","routeSlug":"/openapi/tenant_vpp-token-management","items":[{"label":"Get all VPP tokens for the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/get","routeSlug":"/openapi/tenant_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/get","metadata":{"seo":{"title":"Get all VPP tokens for the tenant","description":"⚠️ iOS/iPadOS/tvOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/vpptokens/"},{"label":"Store a VPP token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/post","routeSlug":"/openapi/tenant_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/post","metadata":{"seo":{"title":"Store a VPP token","description":"⚠️ iOS/iPadOS/tvOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/vpptokens/"},{"label":"Delete VPP Token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1{id}/delete","routeSlug":"/openapi/tenant_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1{id}/delete","metadata":{"seo":{"title":"Delete VPP Token","description":"⚠️ iOS/iPadOS/tvOS only."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/tenant/v0/vpptokens/{id}"}]},{"type":"group","label":"Google Enterprise","link":"/openapi/tenant_google-enterprise","routeSlug":"/openapi/tenant_google-enterprise","items":[{"label":"Generate sign-up URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1enrollment~1begin~1/post","routeSlug":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1enrollment~1begin~1/post","metadata":{"seo":{"title":"Generate sign-up URL","description":"Generate sign-up URL"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/emm/enrollment/begin/"},{"label":"Return the enrollment status of the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1details~1/get","routeSlug":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1details~1/get","metadata":{"seo":{"title":"Return the enrollment status of the Enterprise","description":"Return the enrollment status of the Enterprise"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/emm/details/"},{"label":"Creates a new Google Enterprise with the provided details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1details~1/post","routeSlug":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1details~1/post","metadata":{"seo":{"title":"Creates a new Google Enterprise with the provided details","description":"Creates a new Google Enterprise with the provided details"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/emm/details/"},{"label":"Create a Google Web Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1web-token~1/post","routeSlug":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1web-token~1/post","metadata":{"seo":{"title":"Create a Google Web Token","description":"Create a Google Web Token"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/emm/web-token/"},{"label":"Complete EMM enrollment for a Google Enterprise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1enrollment~1complete~1/post","routeSlug":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1enrollment~1complete~1/post","metadata":{"seo":{"title":"Complete EMM enrollment for a Google Enterprise","description":"Complete EMM enrollment for a Google Enterprise"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/emm/enrollment/complete/"},{"label":"Return the Google Service Account of the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1accounts~1/get","routeSlug":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1accounts~1/get","metadata":{"seo":{"title":"Return the Google Service Account of the Enterprise","description":"Return the Google Service Account of the Enterprise"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/emm/accounts/"},{"label":"Creates a new Google Service Account with the provided details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1accounts~1/post","routeSlug":"/openapi/tenant_google-enterprise/paths/~1v2~1emm~1accounts~1/post","metadata":{"seo":{"title":"Creates a new Google Service Account with the provided details","description":"Creates a new Google Service Account with the provided details"}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/emm/accounts/"}]},{"type":"group","label":"MDM Service Config","link":"/openapi/tenant_mdm-service-config","routeSlug":"/openapi/tenant_mdm-service-config","items":[{"label":"Get MDM service configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_mdm-service-config/getmdmserviceconfig","routeSlug":"/openapi/tenant_mdm-service-config/getmdmserviceconfig","metadata":{"seo":{"title":"Get MDM service configuration","description":"Returns Esper's MDM service configuration for Apple device discovery."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/mdmserviceconfig"},{"label":"Get DEP anchor certificates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tenant_mdm-service-config/getdepanchorcerts","routeSlug":"/openapi/tenant_mdm-service-config/getdepanchorcerts","metadata":{"seo":{"title":"Get DEP anchor certificates","description":"Returns the anchor certificates Esper's MDM service configuration points to for DEP (Device Enrollment Program) enrollment. This is an unauthenticated endpoint, referenced by the dep_anchor_certs_url value in MDM service config — it is not meant to be called directly for day-to-day integration work."}},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/mdmserviceconfig/anchor-certs"}]},{"type":"separator","label":"FOUNDATION"},{"type":"group","label":"FoundryBuilds","link":"/openapi/foundation_foundrybuilds","routeSlug":"/openapi/foundation_foundrybuilds","items":[{"label":"Get Foundry builds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/foundation_foundrybuilds/getfoundrybuilds","routeSlug":"/openapi/foundation_foundrybuilds/getfoundrybuilds","metadata":{"seo":{"title":"Get Foundry builds","description":"Returns a deduplicated list of all Esper Foundation OS version strings currently present across enrolled devices in the tenant."}},"httpPath":"/v1/foundry/builds/"},{"label":"Get Foundry Build","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/foundation_foundrybuilds/paths/~1v1~1foundry~1builds~1{build_id}~1/get","routeSlug":"/openapi/foundation_foundrybuilds/paths/~1v1~1foundry~1builds~1{build_id}~1/get","metadata":{"seo":{"title":"Get Foundry Build","description":"Returns a paginated list of Foundation OS builds registered in the Foundry system, with filters for architecture, Android version, device model, approval status, and more."}},"httpPath":"/v1/foundry/builds/{build_id}/"},{"label":"Update Foundry build","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/foundation_foundrybuilds/updatefoundrybuild","routeSlug":"/openapi/foundation_foundrybuilds/updatefoundrybuild","metadata":{"seo":{"title":"Update Foundry build","description":"Retrieves full details for a single Foundation OS build by its unique Foundry build ID."}},"httpPath":"/v1/foundry/builds/{build_id}/"}]},{"type":"group","label":"FoundryDeviceModels","link":"/openapi/foundation_foundrydevicemodels","routeSlug":"/openapi/foundation_foundrydevicemodels","items":[{"label":"Get device models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/foundation_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1/get","routeSlug":"/openapi/foundation_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1/get","metadata":{"seo":{"title":"Get device models","description":"Returns a list of Foundation-eligible device models registered to the tenant in the Foundry system, with optional filters for manufacturer, model, profile, and Android API level compatibility."}},"httpPath":"/v1/foundry/device-models/"},{"label":"Update Tenant Device Model","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/foundation_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put","routeSlug":"/openapi/foundation_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put","metadata":{"seo":{"title":"Update Tenant Device Model","description":"Configures the auto-update behavior for a Foundation device model — enabling or disabling automatic OS updates and optionally locking updates to a specific approved build or to the latest approved build."}},"httpPath":"/v1/foundry/device-models/{device_model_id}/"}]},{"type":"group","label":"FoundryEvents","link":"/openapi/foundation_foundryevents","routeSlug":"/openapi/foundation_foundryevents","items":[{"label":"Get Foundry events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/foundation_foundryevents/paths/~1v1~1foundry~1events~1/get","routeSlug":"/openapi/foundation_foundryevents/paths/~1v1~1foundry~1events~1/get","metadata":{"seo":{"title":"Get Foundry events","description":"Returns a paginated list of Foundry events in reverse chronological order, providing an audit trail of Foundation build approvals, auto-update configuration changes, and related actions."}},"httpPath":"/v1/foundry/events/"}]},{"type":"separator","label":"REPORTS"},{"type":"group","label":"Reports API","link":"/openapi/reports_reports-api","routeSlug":"/openapi/reports_reports-api","items":[{"label":"Get report types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reports_reports-api/getreporttypes","routeSlug":"/openapi/reports_reports-api/getreporttypes","metadata":{"seo":{"title":"Get report types","description":"Retrieve the list of report types available in the tenant."}},"httpPath":"/report/v0/report-types"},{"label":"Create Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reports_reports-api/createreportstatus","routeSlug":"/openapi/reports_reports-api/createreportstatus","metadata":{"seo":{"title":"Create Report","description":"Initiate generation of a device or device apps report and receive a report ID for status polling. Report availibity varies by operating system."}},"httpPath":"/report/v0/reports"},{"label":"Get report status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reports_reports-api/getreportstatus","routeSlug":"/openapi/reports_reports-api/getreportstatus","metadata":{"seo":{"title":"Get report status","description":"Poll the status of a report and retrieve its results once generation is complete."}},"httpPath":"/report/v0/reports/{report_id}"}]},{"type":"separator","label":"GEOFENCE"},{"type":"group","label":"Geofences","link":"/openapi/geofence_geofences","routeSlug":"/openapi/geofence_geofences","items":[{"label":"Create a new geofence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/geofence_geofences/geofence_creategeofence","routeSlug":"/openapi/geofence_geofences/geofence_creategeofence","metadata":{"seo":{"title":"Create a new geofence","description":"Creates a new geofence for the tenant, defined by its geographic boundary and the device actions to trigger when a device crosses it."}},"httpPath":"/geofence/v1/geofences"},{"label":"List all geofences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/geofence_geofences/geofence_listgeofences","routeSlug":"/openapi/geofence_geofences/geofence_listgeofences","metadata":{"seo":{"title":"List all geofences","description":"Retrieves a paginated list of geofences configured for the tenant. Use it to enumerate all geofences, optionally narrowed down by ID or name."}},"httpPath":"/geofence/v1/geofences"}]},{"type":"group","label":"Device State","link":"/openapi/geofence_device-state","routeSlug":"/openapi/geofence_device-state","items":[{"label":"Get device summary for a geofence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/geofence_device-state/geofence_getdevicesummary","routeSlug":"/openapi/geofence_device-state/geofence_getdevicesummary","metadata":{"seo":{"title":"Get device summary for a geofence","description":"Returns aggregate device statistics for a specific geofence — total device count, how many devices are currently inside the boundary, and how many are outside. Use it for a quick, single-call summary rather than pulling the full device list."}},"httpPath":"/geofence/v1/geofences/{geofence_id}/device-summary"},{"label":"Get blueprint usage statistics for a geofence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/geofence_device-state/geofence_getblueprintusage","routeSlug":"/openapi/geofence_device-state/geofence_getblueprintusage","metadata":{"seo":{"title":"Get blueprint usage statistics for a geofence","description":"Returns paginated statistics on blueprint usage within a specific geofence — which blueprints are applied to devices inside that geofence and how many devices use each. Use it to understand how blueprint-driven configuration correlates with a location-based boundary."}},"httpPath":"/geofence/v1/geofences/{geofence_id}/blueprints"},{"label":"Get devices for a geofence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/geofence_device-state/geofence_getdevices","routeSlug":"/openapi/geofence_device-state/geofence_getdevices","metadata":{"seo":{"title":"Get devices for a geofence","description":"Returns a paginated list of devices and their current state relative to a specific geofence. Use it when you need the actual device records, not just aggregate counts."}},"httpPath":"/geofence/v1/geofences/{geofence_id}/devices"}]}]}