Installed apps

List a device’s installed apps

Returns the apps installed on the device, plus apps its policy requires that failed to install (installed: false). This list is not paginated. The whole inventory comes back in one list object, with hasMore always false and nextCursor always null. Items are sorted by name, then identifier, case-insensitively, with missing names last.

Path parameters

Query parameters

Example request

curl "https://api-gw.weguard.ai/core/v1/devices/6523f1c2a7b9d40012345678/apps?type=store,private" \
  -H "Authorization: Bearer $WEGUARD_API_KEY"

const response = await fetch("https://api-gw.weguard.ai/core/v1/devices/6523f1c2a7b9d40012345678/apps?type=store,private", {
  headers: { Authorization: `Bearer ${process.env.WEGUARD_API_KEY}` },
});

const body = await response.json();
if (!response.ok) {
  throw new Error(`${body.code}: ${body.detail} (requestId ${body.requestId})`);
}
console.log(body);

import os
import requests

response = requests.get(
    "https://api-gw.weguard.ai/core/v1/devices/6523f1c2a7b9d40012345678/apps",
    params={"type": "store,private"},
    headers={"Authorization": f"Bearer {os.environ['WEGUARD_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

Response

A list object whose data holds every matching installed app object.

{
  "object": "list",
  "data": [
    {
      "object": "installed_app",
      "identifier": "com.acme.scanner",
      "name": null,
      "type": "private",
      "version": "3.2.0",
      "versionCode": "320",
      "installed": false,
      "publisher": null,
      "sizeBytes": null,
      "installedAt": null,
      "status": null,
      "error": {
        "code": "NOT_COMPATIBLE_WITH_DEVICE",
        "message": "The app is not compatible with this device."
      }
    },
    {
      "object": "installed_app",
      "identifier": "com.android.chrome",
      "name": null,
      "type": "store",
      "version": "126.0.6478.71",
      "versionCode": "647807131",
      "installed": true,
      "publisher": null,
      "sizeBytes": null,
      "installedAt": null,
      "status": null,
      "error": null
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

Errors

• 404resource_not_found

  No device with this id exists in your account.

• 400invalid_parameter

  type contains an unsupported value, includeSystem is not true/false, or a parameter was sent twice.

• 400unknown_parameter

  The request includes another query parameter. This endpoint is not paginated, so it rejects limit and cursor too.

• 403insufficient_scope

  The key lacks apps:read.

Common errors

Besides the errors listed for each endpoint, any request can fail authentication, exceed the rate limit, ask for a format other than JSON, or fail with a server error. See Errors for the response format and retry guidance.

• 401missing_credentials

  The request has no Authorization header.

• 401invalid_authorization_header

  The Authorization header does not use the Bearer scheme, or has no key after it. The WWW-Authenticate header carries error="invalid_request".

• 401invalid_api_key

  The key is malformed, does not exist, or its secret does not match. The WWW-Authenticate header carries error="invalid_token".

• 401api_key_expired

  The key is past its expiresAt.

• 401api_key_revoked

  An account admin revoked the key. Revocation takes effect immediately and cannot be undone.

• 403account_inactive

  The WeGuard account that owns the key has been deleted or disabled.

• 406not_acceptable

  The Accept header excludes JSON.

• 429rate_limit_exceeded

  The key has used up its request budget. See Rate limits.

• 500internal_error

  An unexpected error occurred on our side.

• 503service_unavailable

  A service WeGuard depends on is temporarily unavailable, or reading the data took longer than the time WeGuard allows for it. This can also happen while your key is being checked, so it can be returned before authentication completes. The response carries Retry-After.