OpenMeter Apps

List apps

Changed on

List installed apps.

get/openmeter/apps

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/apps
  • Auth: none declared

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sort apps returned in the response. Supported sort attributes are:

  • id
  • created_at (default)

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.

Filter apps returned in the response.

To filter apps by name add the following query param: filter[name]=my-app

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH"
}

Response

Page paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "labels": {
        "env": "test"
      },
      "created_at": "2023-01-01T01:01:01.001Z",
      "updated_at": "2023-01-01T01:01:01.001Z",
      "deleted_at": "2023-01-01T01:01:01.001Z",
      "definition": {
        "type": "stripe",
        "name": "Stripe",
        "description": "Stripe integration allows you to collect payments with Stripe.",
        "capabilities": [
          {
            "type": "calculate_tax",
            "key": "stripe_calculate_tax",
            "name": "Calculate Tax",
            "description": "Stripe Tax calculates tax portion of the invoices."
          },
          {
            "type": "invoice_customers",
            "key": "stripe_invoice_customers",
            "name": "Invoice Customers",
            "description": "Stripe invoices customers with due amount."
          },
          {
            "type": "collect_payments",
            "key": "stripe_collect_payments",
            "name": "Collect Payments",
            "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
          }
        ],
        "install_methods": [
          "with_oauth2",
          "with_api_key"
        ]
      }
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

  • v37af50c906f9aRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • v36635b87ab7b0Revision changes
    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter sort