API : FlexCare : App whitelist : Get

Introduction

This will get a single whitelisted app

This whitelist is used to determine which apps can be assigned to a tablet profile.

Request

URL	https://api.telecomx.dk/flexcare/appwhitelist/APP_ID
Method	GET
Access level	VIEWER, MANAGER or OWNER — the app must be available to the user's customer (its `customerWhitelist` is empty or includes the customer) RESELLER admin and ADMIN can retrieve any app
Param	APP_ID	Unique id (ObjectId) of the app
Query	full	Boolean	`[optional]` If true, then `customerWhitelist` is returned as an array of customer objects instead of an array of IDs

Query examples

https://api.telecomx.dk/flexcare/appwhitelist/1234567890ABCD1234567890
https://api.telecomx.dk/flexcare/appwhitelist/1234567890ABCD1234567890?full=true

Response

JSON object
_id	ObjectId	Unique id of the app
packageName	String	Android package name
name	String	App name
description	String	App description
icon	ObjectId	Id of the icon image (null if none)
iconUrl	String	Icon URL. Derived from `icon` when set, otherwise the stored URL.
iconFileName	String	File name of the icon. Present only when the icon's file is found.
private	Boolean	Should be set if app is not in an app store
whitelistOnly	Boolean	True if app should not be installed nor validated for correct version
autoUpdateDefault	Boolean	Used to tell the automatic version fetcher that it should move the default flag to the newest version when one is found
androidTV	Boolean	Used to tell the automatic version fetcher that it should find the Android TV version of the application
minimumVersion	Number	Minimum build version wanted
apks	Array	List of APKs for different versions of this app
apks[]._id	ObjectId	Unique object id of the APK
apks[].version	String	App version
apks[].versionCode	Number	Android version code (build number)
apks[].default	Boolean	True if this is chosen as the default version of the app
apks[].minAndroidVersion	Number	Minimum Android version required for this APK
apks[].file	ObjectId	File id of the APK (null if none)
apks[].fileName	String	File name of the APK. Present only when the file is found.
apks[].notes	String	Release notes for this version
apks[].releaseDate	Date	Date the version was added
apks[].bundle	Array	Additional files bundled with the APK
apks[].bundle[].file	ObjectId	File id of the bundled file
apks[].bundle[].url	String	URL of the bundled file
apks[].bundle[].fileName	String	File name of the bundled file. Present only when the file is found.
customerWhitelist	Array	Array of customer IDs (ObjectIds). If the list is empty, then the app is allowed to be added to all tablet profiles. If it's not empty, then the customers added to this list are the only ones allowed to use this app. Note that if a reseller is added to this list, then all of their customers are also allowed to access this app.

If full=true
customerWhitelist	Array	Array of customer objects
customerWhitelist[]._id	ObjectId	Id
customerWhitelist[].name	String	Customer name
customerWhitelist[].emailAddress	String	Customer's email address
customerWhitelist[].phoneNumber	String	Phone number
customerWhitelist[].parentReseller	ObjectId	Id of the customer's parent reseller. If the customer is a reseller, then this is null or omitted.

Example

{
  _id: "1234567890ABCD1234567890",
  packageName: "com.fitnessapps.marafun",
  name: "MaraFUN",
  description: "",
  icon: "1234567890ABCD1234567890",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  iconFileName: "marafun200x200.png",
  private: false,
  whitelistOnly: false,
  autoUpdateDefault: false,
  androidTV: false,
  minimumVersion: 0,
  apks: [
    {
      _id: "1234567890ABCD1234657980",
      version: "1.0",
      versionCode: 100,
      default: true,
      minAndroidVersion: 8,
      file: "1224657890ABCD1234567980",
      fileName: "Marathon V. 1.0",
      notes: "",
      releaseDate: "2026-05-01T10:00:00.000Z",
      bundle: []
    }
  ],
  customerWhitelist: [
    "1234567890ABCD1234567890",
    "7234567890ABCD1234567890"
  ]
}

Example if full=true

{
  _id: "1234567890ABCD1234567890",
  packageName: "com.fitnessapps.marafun",
  name: "MaraFUN",
  description: "",
  icon: "1234567890ABCD1234567890",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  iconFileName: "marafun200x200.png",
  private: false,
  whitelistOnly: false,
  autoUpdateDefault: false,
  androidTV: false,
  minimumVersion: 0,
  apks: [
    {
      _id: "1234567890ABCD1234657980",
      version: "1.0",
      versionCode: 100,
      default: true,
      minAndroidVersion: 8,
      file: "1224657890ABCD1234567980",
      fileName: "Marathon V. 1.0",
      notes: "",
      releaseDate: "2026-05-01T10:00:00.000Z",
      bundle: []
    }
  ],
  customerWhitelist: [
    {
      _id: "1234567890ABCD1234567890",
      name: "Hans Hansens Hestevæddeløbsbane ApS",
      emailAddress: "hans@hestevaeddelob.dk",
      phoneNumber: "+4560828313",
      parentReseller: "1234567890ABCD1234567890"
    },
    {
      _id: "7234567890ABCD1234567890",
      name: "Erik Erlangs Elektrikerfirma A/S",
      emailAddress: "erik@elektriker.dk",
      phoneNumber: "+4577828313",
      parentReseller: "1234567890ABCD1234567890"
    }
  ]
}

Errors

Error code	Message	Description
422	id	Invalid app id (must be a 24-character hex ObjectId).
403	access_denied	Insufficient access level
404	id	App not found. Also returned when the app is not whitelisted for the user's customer.
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : FlexCare : App whitelist : Get

Introduction

Request

Query examples

Response

Example

Example if full=true

Errors