---
updatedAt: 2026-05-26T21:35:11.000Z
agentTools:
  projectIndex: https://developers.lumos.com/llms.txt
---

# Get Appstore Apps

List all AppStore apps.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Lumos",
    "description": "\n    The Lumos API gives you the building blocks to administer and extend Lumos programmatically.\n    Our REST API provides a management interface for the AppStore and a read interface\n    for the Lumos Core.\n    Go to https://developers.lumos.com to see our complete documentation.\n",
    "version": "0.1.0"
  },
  "servers": [
    {
      "url": "https://api.lumos.com"
    }
  ],
  "paths": {
    "/appstore/apps": {
      "get": {
        "tags": [
          "AppStore"
        ],
        "summary": "Get Appstore Apps",
        "description": "List all AppStore apps.",
        "operationId": "getAppStoreApps",
        "security": [
          {
            "HTTPBearer": []
          }
        ],
        "parameters": [
          {
            "name": "app_id",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Filters apps by the ID of the app.",
              "title": "App Id"
            },
            "description": "Filters apps by the ID of the app."
          },
          {
            "name": "name_search",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "description": "Search against name, app instance identifier, and app class ID.",
              "title": "Name Search"
            },
            "description": "Search against name, app instance identifier, and app class ID."
          },
          {
            "name": "exact_match",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "description": "Search filter should be an exact match.",
              "default": false,
              "title": "Exact Match"
            },
            "description": "Search filter should be an exact match."
          },
          {
            "name": "all_visibilities",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "description": "Get all apps in the AppStore regardless of visibility. Only available to admins.",
              "default": false,
              "title": "All Visibilities"
            },
            "description": "Get all apps in the AppStore regardless of visibility. Only available to admins."
          },
          {
            "name": "expand",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "null"
                }
              ],
              "description": "Fields to expand. Supported fields: custom_attributes.",
              "title": "Expand"
            },
            "description": "Fields to expand. Supported fields: custom_attributes."
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Page number",
              "default": 1,
              "title": "Page"
            },
            "description": "Page number"
          },
          {
            "name": "size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 100,
              "minimum": 1,
              "description": "Page size",
              "default": 50,
              "title": "Size"
            },
            "description": "Page size"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Page_AppStoreApp_"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AppLinks": {
        "properties": {
          "self": {
            "type": "string",
            "title": "Self",
            "description": "The canonical API URL for retrieving this specific application"
          },
          "admin_url": {
            "type": "string",
            "title": "Admin Url",
            "description": "A URL to access this application within the Lumos web UI"
          }
        },
        "type": "object",
        "required": [
          "self",
          "admin_url"
        ],
        "title": "AppLinks"
      },
      "AppStoreApp": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "The ID of this app."
          },
          "app_class_id": {
            "type": "string",
            "title": "App Class Id",
            "description": "The non-unique ID of the service associated with this requestable permission. Depending on how it is sourced in Lumos, this may be the app's name, website, or other identifier."
          },
          "instance_id": {
            "type": "string",
            "title": "Instance Id",
            "description": "The non-unique ID of the instance associated with this app. This will be the Okta app id if it’s an Okta app, or will be marked as custom_app_import if manually uploaded into Lumos."
          },
          "user_friendly_label": {
            "type": "string",
            "title": "User Friendly Label",
            "description": "The user-friendly label of this app."
          },
          "status": {
            "$ref": "#/components/schemas/DomainAppStatus",
            "description": "The status of this app. Possible values: 'DISCOVERED', 'IN_REVIEW', 'NEEDS_REVIEW', 'APPROVED', 'BLOCKLISTED', 'DEPRECATED'"
          },
          "sources": {
            "items": {
              "$ref": "#/components/schemas/DiscoverySource"
            },
            "type": "array",
            "title": "Sources",
            "description": "The sources of this app."
          },
          "allow_multiple_permission_selection": {
            "type": "boolean",
            "title": "Allow Multiple Permission Selection",
            "description": "Determines whether users can request multiple permissions at once.This field will be removed in subsequent API versions."
          },
          "logo_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Logo Url",
            "description": "The URL of the logo of this app."
          },
          "website_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Website Url",
            "description": "The URL of the website of this app."
          },
          "request_instructions": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Request Instructions",
            "description": "The request instructions."
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Description",
            "description": "The user-facing description of the app"
          },
          "category": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Category",
            "description": "The category of the app, as shown in the AppStore"
          },
          "disconnected": {
            "type": "boolean",
            "title": "Disconnected",
            "description": "Whether this app has been disconnected (its stored credentials removed via `DELETE /apps/{app_id}`). A disconnected app is excluded from `GET /apps?disconnected=false`; reconnect it with `PUT /apps/{app_id}`."
          },
          "links": {
            "$ref": "#/components/schemas/AppLinks",
            "description": "A collection of URLs related to this application"
          },
          "sync_status": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/SyncStatus"
              },
              {
                "type": "null"
              }
            ],
            "description": "The state of this app's most recent sync: `SYNCING` while one is running, `SUCCESS` or `FAILED` once it finished. Poll this after `POST /apps/{app_id}/sync` to follow that sync. `null` when no sync result is recorded — the app has never synced, or was disconnected."
          },
          "custom_attributes": {
            "anyOf": [
              {
                "additionalProperties": {
                  "$ref": "#/components/schemas/CustomAttribute"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "title": "Custom Attributes",
            "description": "Custom attributes configured on the app"
          }
        },
        "type": "object",
        "required": [
          "id",
          "app_class_id",
          "instance_id",
          "user_friendly_label",
          "status",
          "sources",
          "allow_multiple_permission_selection",
          "disconnected",
          "links"
        ],
        "title": "AppStoreApp"
      },
      "CustomAttribute": {
        "properties": {
          "type": {
            "$ref": "#/components/schemas/CustomAttributeType",
            "description": "The type of custom attribute. Only text and user options are available today"
          },
          "value": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "items": {
                  "$ref": "#/components/schemas/User"
                },
                "type": "array"
              },
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Value",
            "description": "The value of the attribute for an individual Order"
          }
        },
        "type": "object",
        "required": [
          "type"
        ],
        "title": "CustomAttribute"
      },
      "CustomAttributeType": {
        "type": "string",
        "enum": [
          "TEXT",
          "USER",
          "SINGLE_SELECT"
        ],
        "title": "CustomAttributeType"
      },
      "DiscoverySource": {
        "type": "string",
        "enum": [
          "GSUITE_QUICK_INBOX",
          "GSUITE_DEEP_INBOX",
          "MICROSOFT_DEEP_INBOX",
          "MICROSOFT_OAUTH",
          "MICROSOFT_GCC",
          "GSUITE_OAUTH",
          "OKTA",
          "MANUAL",
          "ONELOGIN",
          "ATLASSIAN",
          "GOOGLE_CLOUD",
          "LUMOS_INTEGRATION",
          "JUMPCLOUD",
          "CUSTOM",
          "MCP",
          "NATIVE"
        ],
        "title": "DiscoverySource"
      },
      "DomainAppStatus": {
        "type": "string",
        "enum": [
          "DISCOVERED",
          "IN_REVIEW",
          "NEEDS_REVIEW",
          "APPROVED",
          "BLOCKLISTED",
          "DEPRECATED"
        ],
        "title": "DomainAppStatus"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "Page_AppStoreApp_": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/AppStoreApp"
            },
            "type": "array",
            "title": "Items"
          },
          "total": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0
              },
              {
                "type": "null"
              }
            ],
            "title": "Total"
          },
          "page": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Page"
          },
          "size": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 1
              },
              {
                "type": "null"
              }
            ],
            "title": "Size"
          },
          "pages": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0
              },
              {
                "type": "null"
              }
            ],
            "title": "Pages"
          }
        },
        "type": "object",
        "required": [
          "items",
          "total",
          "page",
          "size"
        ],
        "title": "Page[AppStoreApp]"
      },
      "SyncStatus": {
        "type": "string",
        "enum": [
          "SYNCING",
          "SUCCESS",
          "FAILED"
        ],
        "title": "SyncStatus"
      },
      "User": {
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "The ID of this user."
          },
          "email": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Email",
            "description": "The email of this user."
          },
          "given_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Given Name",
            "description": "The given name of this user."
          },
          "family_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Family Name",
            "description": "The family name of this user."
          },
          "status": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/UserLifecycleStatus"
              },
              {
                "type": "null"
              }
            ],
            "description": "The status of this user."
          }
        },
        "type": "object",
        "required": [
          "id"
        ],
        "title": "User"
      },
      "UserLifecycleStatus": {
        "type": "string",
        "enum": [
          "STAGED",
          "ACTIVE",
          "SUSPENDED",
          "INACTIVE"
        ],
        "title": "UserLifecycleStatus"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    },
    "securitySchemes": {
      "HTTPBearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```