---
title: "List apps"
method: GET
path: "/api/v1/apps"
tags: ["Apps"]
---

# List apps

`GET /api/v1/apps`

List apps.

## Query parameters

- `page` integer
- `pageSize` integer

## Response `200`

The request has succeeded.

- AppPaginatedResponse — Paginated response
  - `items` App[], required — The items in the current page.
    - union — App. One of: stripe
      - object — A installed Stripe app object.
        - `createdAt` string, date-time, required — Timestamp of when the resource was created.
        - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted.
        - `description` string — Optional description of the resource. Maximum 1024 characters.
        - `id` string, required — A unique identifier for the resource.
        - `listing` MarketplaceListing, required — A marketplace listing. Represent an available app in the app marketplace that can be installed to the organization. Marketplace apps only exist in config so they don't extend the Resource model.
          - `capabilities` AppCapability[], required — The app's capabilities.
            - `description` string, required — The capability description.
            - `key` string, required — Key
            - `name` string, required — The capability name.
            - `type` 'reportUsage' | 'reportEvents' | 'calculateTax' | 'invoiceCustomers' | 'collectPayments', required — App capability type.
          - `description` string, required — The app's description.
          - `installMethods` InstallMethod[], required — Install methods. List of methods to install the app.
          - `name` string, required — The app's name.
          - `type` 'stripe' | 'sandbox' | 'custom_invoicing', required — Type of the app.
        - `livemode` boolean, required — Livemode, true if the app is in production mode.
        - `maskedAPIKey` string, required — The masked API key. Only shows the first 8 and last 3 characters.
        - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource.
        - `name` string, required — Human-readable name for the resource. Between 1 and 256 characters.
        - `status` 'ready' | 'unauthorized', required — App installed status.
        - `stripeAccountId` string, required — The Stripe account ID.
        - `type` 'stripe', required — The app's type is Stripe.
        - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated.
      - object — Sandbox app can be used for testing OpenMeter features. The app is not creating anything in external systems, thus it is safe to use for verifying OpenMeter features.
        - `createdAt` string, date-time, required — Timestamp of when the resource was created.
        - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted.
        - `description` string — Optional description of the resource. Maximum 1024 characters.
        - `id` string, required — A unique identifier for the resource.
        - `listing` MarketplaceListing, required — A marketplace listing. Represent an available app in the app marketplace that can be installed to the organization. Marketplace apps only exist in config so they don't extend the Resource model.
          - `capabilities` AppCapability[], required — The app's capabilities.
            - `description` string, required — The capability description.
            - `key` string, required — Key
            - `name` string, required — The capability name.
            - `type` 'reportUsage' | 'reportEvents' | 'calculateTax' | 'invoiceCustomers' | 'collectPayments', required — App capability type.
          - `description` string, required — The app's description.
          - `installMethods` InstallMethod[], required — Install methods. List of methods to install the app.
          - `name` string, required — The app's name.
          - `type` 'stripe' | 'sandbox' | 'custom_invoicing', required — Type of the app.
        - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource.
        - `name` string, required — Human-readable name for the resource. Between 1 and 256 characters.
        - `status` 'ready' | 'unauthorized', required — App installed status.
        - `type` 'sandbox', required — The app's type is Sandbox.
        - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated.
      - object — Custom Invoicing app can be used for interface with any invoicing or payment system. This app provides ways to manipulate invoices and payments, however the integration must rely on Notifications API to get notified about invoice changes.
        - `createdAt` string, date-time, required — Timestamp of when the resource was created.
        - `deletedAt` string, date-time — Timestamp of when the resource was permanently deleted.
        - `description` string — Optional description of the resource. Maximum 1024 characters.
        - `enableDraftSyncHook` boolean, required — Enable draft.sync hook. If the hook is not enabled, the invoice will be progressed to the next state automatically.
        - `enableIssuingSyncHook` boolean, required — Enable issuing.sync hook. If the hook is not enabled, the invoice will be progressed to the next state automatically.
        - `id` string, required — A unique identifier for the resource.
        - `listing` MarketplaceListing, required — A marketplace listing. Represent an available app in the app marketplace that can be installed to the organization. Marketplace apps only exist in config so they don't extend the Resource model.
          - `capabilities` AppCapability[], required — The app's capabilities.
            - `description` string, required — The capability description.
            - `key` string, required — Key
            - `name` string, required — The capability name.
            - `type` 'reportUsage' | 'reportEvents' | 'calculateTax' | 'invoiceCustomers' | 'collectPayments', required — App capability type.
          - `description` string, required — The app's description.
          - `installMethods` InstallMethod[], required — Install methods. List of methods to install the app.
          - `name` string, required — The app's name.
          - `type` 'stripe' | 'sandbox' | 'custom_invoicing', required — Type of the app.
        - `metadata` Metadata — Set of key-value pairs. Metadata can be used to store additional information about a resource.
        - `name` string, required — Human-readable name for the resource. Between 1 and 256 characters.
        - `status` 'ready' | 'unauthorized', required — App installed status.
        - `type` 'custom_invoicing', required — The app's type is CustomInvoicing.
        - `updatedAt` string, date-time, required — Timestamp of when the resource was last updated.
  - `page` integer, required — The page index.
  - `pageSize` integer, required — The maximum number of items per page.
  - `totalCount` integer, required — The total number of items.

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
- `401` — The request has not been applied because it lacks valid authentication credentials for the target resource.
- `403` — The server understood the request but refuses to authorize it.
- `412` — One or more conditions given in the request header fields evaluated to false when tested on the server.
- `500` — The server encountered an unexpected condition that prevented it from fulfilling the request.
- `503` — The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
- `default` — An unexpected error response.

---

[API](https://skmtc.dev/openmeter/apis/openmeter-cloud-api.md) · [All operations](https://skmtc.dev/openmeter/apis/openmeter-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openmeter/openmeter-cloud-api/revisions/c9c0ec9cffe9/schema)