API : FlexCare : App whitelist : List

Introduction

This will list all the apps which a FlexCare customer has access to.

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

An app is available to a customer when the app's customer whitelist contains the customer or the customer's reseller, or when the app has no customer whitelist (available to everyone).

Request

URL	https://api.telecomx.dk/flexcare/appwhitelist
Method	GET
Access level	VIEWER, MANAGER or OWNER — customer must have the FLEXCARE feature RESELLER or above may view other customers via `customer` (the customer must have the FLEXCARE feature) RESELLER admin (with the TV employee feature) for cross-customer access via `all` ADMIN
Query	offset	`[optional]` Index of the first app to return, default 0, min 0, max 1000000.
	limit	`[optional]` The number of apps to return, default 100, min 1, max 1000000. For non-ADMIN users, values above 500 are reduced to 500.
	filter	`[optional]` Filters the apps on name or package name.
	all	`[optional]` If true, apps for all customers and resellers are returned (ADMIN, or RESELLER admin with the TV employee feature, only — ignored for other users).
	customer	`[optional]` Id of the customer to show apps for. Defaults to the user's own customer. Only RESELLER or above may specify another customer.
	type	`[optional]` Filter by app type. `ANDROIDTV` returns only Android TV apps; `DEFAULT` returns only non-Android-TV apps. Omit to return both.
	compact	`[optional]` If `true`, each app is returned in a reduced form (see Compact response below). Must be `true` or `false`.

Query examples

https://api.telecomx.dk/flexcare/appwhitelist
https://api.telecomx.dk/flexcare/appwhitelist?offset=25&limit=50&customer=12345678901234567890ABCD&filter=chess
https://api.telecomx.dk/flexcare/appwhitelist?all=true&filter=chess
https://api.telecomx.dk/flexcare/appwhitelist?compact=true

Response

JSON object
total	Number of apps that match the query when offset and limit are not considered. This is to be used for paging through the data.
offset	Index of the first app returned.
limit	Number of apps requested. Note that the actual number of apps returned may be lower.
apps	Array of apps sorted alphabetically by name, see definition below.

App
_id	ObjectId	Unique id of the app
name	String	App name
packageName	String	Android package name
icon	ObjectId	Id of the icon image (null if none)
iconUrl	String	Icon URL. Derived from `icon` when set (a `token` query parameter is appended when the request is authenticated with a token), otherwise the stored URL.
androidTV	Boolean	Whether the app is an Android TV application
private	Boolean	Whether the app is private
autoUpdateDefault	Boolean	Whether auto-update is enabled by default for this app
minAndroidVersion	Number	Minimum Android version taken from the most recently added APK (by `releaseDate`). 0 when the app has no APKs.
apks	Array	List of APKs for different versions of this app, sorted by `versionCode` descending (newest version first)
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[].notes	String	Release notes for this version
apks[].releaseDate	Date	When this APK version was added
apks[].bundle	Array	Additional files bundled with the APK, each `{ file: ObjectId, url: String }`

Compact response

When compact=true, each entry in apps contains only the following fields:

App (compact)
_id	ObjectId	Unique id of the app
name	String	App name
packageName	String	Android package name
icon	ObjectId	Id of the icon image (null if none)
iconUrl	String	Icon URL
minAndroidVersion	Number	Minimum Android version taken from the most recently added APK (by `releaseDate`). 0 when the app has no APKs.

Example

{
   total: 1,
   offset: 0,
   limit: 100,
   apps: [
     {
       _id: "1234567890ABCD1234567890",
       name: "MaraFUN",
       packageName: "com.fitnessapps.marafun",
       icon: "1234567890ABCD1234567890",
       iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
       androidTV: false,
       private: false,
       autoUpdateDefault: false,
       minAndroidVersion: 8,
       apks: [
         {
           _id: "1234567890ABCD1234567890",
           version: "1.0",
           versionCode: 100,
           default: true,
           minAndroidVersion: 8,
           file: "1234567890ABCD1234567890",
           notes: "",
           releaseDate: "2026-05-01T10:00:00.000Z",
           bundle: []
         }
       ]
     }
   ]
}

Compact example

{
   total: 1,
   offset: 0,
   limit: 100,
   apps: [
     {
       _id: "1234567890ABCD1234567890",
       name: "MaraFUN",
       packageName: "com.fitnessapps.marafun",
       icon: "1234567890ABCD1234567890",
       iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
       minAndroidVersion: 8
     }
   ]
}

Errors

Error code	Message	Description
422	<field name>	Invalid value for a query parameter (`offset`, `limit`, `customer`, `type` or `compact`).
403	access_denied	Insufficient access level, or the customer does not have the FLEXCARE feature
404	customer	Customer not found (also returned when a non-reseller user requests another customer)
500	internal_error	<Unspecified>

</code>

WIKI

Table of Contents