> ## Documentation Index
> Fetch the complete documentation index at: https://docs.phoneuse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List installable apps

> Managed Android app store. Requires apps:read, devices:read. Catalogue sources stay on the server. Accepted installs persist before the worker uses native action governance, leases and receipts. After uncertain dispatch only original-receipt and fresh inventory reads run; no automatic reinstall. Installed requires verified exact phone, primary profile, package and catalogue version. All history is tenant/device scoped; activeItems repeats every held installation on each bounded page.



## OpenAPI

````yaml /api/openapi.json get /v1/app-store/catalog
openapi: 3.1.0
info:
  title: Phonebase HTTP API
  version: 0.1.0
  summary: >-
    Every HTTP operation the control plane mounts, generated from the app's own
    route table.
  description: >-
    The control plane exposes two HTTP surfaces, and reading the boundary
    between them matters more than reading any single endpoint.


    The CONTROL surface is what your backend and your operators call. It takes a
    bearer token in the `Authorization` header, and two credential channels
    resolve to the same authorization context: an OAuth 2.1 access token for
    interactive clients, or an org scoped API key for headless ones.


    The DEVICE surface, under `/vrx/{runToken}/v1`, is what a worker calls while
    executing one run. Its credential is the run token in the url path, and it
    reads no `Authorization` header at all.


    Device control itself is not REST. An agent taps, swipes and reads the
    screen over the Model Context Protocol at `POST /mcp`, one tool call at a
    time. There is no `POST /v1/devices/{id}/tap`, and if you are looking for
    one, start with the tool reference instead.


    Operations marked `"x-phonebase-modes": ["hosted"]` exist only on a hosted
    deployment; a local checkout does not mount them.
servers:
  - url: '{origin}'
    description: Your control plane origin.
    variables:
      origin:
        default: https://mcp.phonebase.co
        enum:
          - https://mcp.phonebase.co
          - http://127.0.0.1:8788
        description: >-
          The hosted deployment serves the public origin its metadata document
          advertises, and that is the default here. Select the loopback entry
          instead when you are running a local checkout, which serves the port
          `PORT` names.
security: []
tags:
  - name: Apps
    description: Save immutable application builds and manage explicit device operations.
  - name: Managed Proxy
    description: >-
      Organization-owned fixed egress resources, independent one-time orders and
      verified network relationships.
  - name: Health
    description: Liveness, unauthenticated.
  - name: Gateway enrollment
    description: >-
      How a new gateway computer trades a one-time enrollment code for its
      tunnel credential. Unauthenticated: the code is the credential.
  - name: Gateway releases
    description: >-
      What a gateway computer installs: the current edge release of a channel.
      Called with the gateway's own credential.
  - name: MCP
    description: The JSON-RPC endpoint an agent drives devices through.
  - name: Copilot
    description: >-
      Drive a device by chatting. A signed in person's own conversations,
      streamed. Hosted deployments only.
  - name: Discovery
    description: Where to authenticate. Served on hosted deployments only.
  - name: Runs
    description: Start, watch and steer a run.
  - name: API keys
    description: Mint and revoke headless credentials. Hosted deployments only.
  - name: Device surface
    description: What a worker calls with its run token to observe and act.
  - name: Usage
    description: Read your org's own receipts and consumption. Hosted deployments only.
  - name: Devices
    description: Read the fleet your credential can see. Hosted deployments only.
  - name: Notifications
    description: >-
      What a person needs to know when they are not watching, and which emails
      they receive. Hosted deployments only.
  - name: Webhooks
    description: >-
      Subscribe your own system to what happens here, and read what was
      delivered. Hosted deployments only.
  - name: Provisioning
    description: >-
      Whether an organisation is provisioned, and how it becomes so. Hosted
      deployments only, and both operations answer a declared 503 on a
      deployment that cannot provision yet.
paths:
  /v1/app-store/catalog:
    get:
      tags:
        - Apps
      summary: List installable apps
      description: >-
        Managed Android app store. Requires apps:read, devices:read. Catalogue
        sources stay on the server. Accepted installs persist before the worker
        uses native action governance, leases and receipts. After uncertain
        dispatch only original-receipt and fresh inventory reads run; no
        automatic reinstall. Installed requires verified exact phone, primary
        profile, package and catalogue version. All history is tenant/device
        scoped; activeItems repeats every held installation on each bounded
        page.
      operationId: getV1AppStoreCatalog
      responses:
        '200':
          description: Current managed store state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedStoreCatalog'
        '400':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLibraryErrorEnvelope'
        '401':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLibraryErrorEnvelope'
        '403':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLibraryErrorEnvelope'
        '404':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLibraryErrorEnvelope'
        '409':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLibraryErrorEnvelope'
        '413':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLibraryErrorEnvelope'
        '429':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.


            Or: Over the request budget for this caller. Hosted deployments
            only. Which budget applied depends on whether this request carried
            an `Authorization` header, not on which endpoint it was aimed at.
            Wait `Retry-After` seconds and retry the same request: the refusal
            happens before any work, so nothing was partially applied. See
            /api/rate-limits.
          headers:
            Retry-After:
              description: >-
                Whole seconds until one request is available again. Computed
                from the caller's own remaining allowance, not a fixed constant.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The budget in effect for this caller class, in requests per
                minute.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                Whole requests that were still available when this request was
                admitted. Zero on a 429.
              schema:
                type: string
            RateLimit-Reset:
              description: >-
                Seconds until the allowance is back to full. Longer than
                `Retry-After`, which is the wait for a single request.
              schema:
                type: string
            RateLimit-Policy:
              description: The budget and its window, as `<limit>;w=60`.
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AppLibraryErrorEnvelope'
                  - $ref: '#/components/schemas/RateLimitedError'
        '503':
          description: >-
            The original request is refused or unavailable. An ambiguous write
            must be queried by its original request key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppLibraryErrorEnvelope'
      security:
        - bearerAuth: []
components:
  schemas:
    ManagedStoreCatalog:
      type: object
      additionalProperties: false
      properties:
        capability:
          type: string
          const: managed-app-store-v1
        items:
          type: array
          items:
            $ref: '#/components/schemas/ManagedStoreCatalogApp'
          maxItems: 100
        installationAvailable:
          type: boolean
      required:
        - capability
        - items
        - installationAvailable
    AppLibraryErrorEnvelope:
      type: object
      additionalProperties: false
      properties:
        error:
          $ref: '#/components/schemas/AppLibraryError'
      required:
        - error
      examples:
        - error:
            code: preview_changed
            message: A selected device has changed. Review the devices again.
            requestId: req_01
            field: null
            retry: new_preview
            retryAfterSeconds: null
    RateLimitedError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: rate_limited
              description: Always `rate_limited` on this response.
            message:
              type: string
              description: >-
                A human readable summary. The numbers are in the headers, not in
                here.
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        Over the request budget. Raised by the rate limiter before any handler
        runs, which is why its code is not one of the action codes: nothing was
        attempted, so no action failed.
    ManagedStoreCatalogApp:
      type: object
      additionalProperties: false
      properties:
        appId:
          type: string
          minLength: 1
          maxLength: 160
        buildId:
          type: string
          minLength: 1
          maxLength: 160
        name:
          type: string
        category:
          type: string
        packageName:
          type: string
        versionName:
          type: string
        summary:
          type: string
        icon:
          type: string
        installable:
          type: boolean
      required:
        - appId
        - buildId
        - name
        - category
        - packageName
        - versionName
        - summary
        - icon
        - installable
    AppLibraryError:
      type: object
      additionalProperties: false
      properties:
        code:
          $ref: '#/components/schemas/AppLibraryErrorCode'
        message:
          type: string
        requestId:
          $ref: '#/components/schemas/AppLibraryId'
        field:
          anyOf:
            - type: string
            - type: 'null'
        retry:
          type: string
          enum:
            - none
            - same_key_after_delay
            - query_original
            - new_preview
        retryAfterSeconds:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
      required:
        - code
        - message
        - requestId
        - field
        - retry
        - retryAfterSeconds
      description: >-
        Stable PhoneBase business/request error. No provider payloads, signed
        URLs, stack traces or internal action keys. HTTP error is distinct from
        a persisted job result.
    AppLibraryErrorCode:
      type: string
      enum:
        - invalid_argument
        - unauthenticated
        - permission_denied
        - not_found
        - idempotency_conflict
        - request_in_progress
        - idempotency_window_expired
        - cursor_expired
        - cursor_mismatch
        - quota_exceeded
        - version_unavailable
        - version_referenced
        - upload_not_ready
        - upload_expired
        - upload_rejected
        - duplicate_archived
        - deletion_pending
        - checksum_mismatch
        - unsupported_format
        - metadata_unavailable
        - preview_expired
        - preview_changed
        - target_ineligible
        - retry_not_safe
        - rate_limited
        - feature_unavailable
        - service_unavailable
        - precondition_failed
        - file_too_large
    AppLibraryId:
      type: string
      pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
      examples:
        - app_01
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The control surface credential. Send `Authorization: Bearer <token>`.


        Two kinds of token are accepted and they are told apart by shape, not by
        a separate header. A token beginning `pbk_` is an org scoped API key,
        whose public half and secret half are generated together and of which
        only a hash of the secret is ever stored; anything else is treated as an
        OAuth 2.1 access token and verified against the authorization server's
        keys.


        Both resolve to the same context: an org, a principal and a set of
        scopes. Nothing downstream branches on which channel you used, with one
        deliberate exception, key management, which requires a signed-in person
        so that a key can never mint another key.


        Scopes are enforced when MCP tools are REGISTERED rather than when they
        are called, so a tool your credential cannot use is absent from
        `tools/list` rather than refused mid gesture.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.