Apps

List apps

List apps.

get/api/v1/apps

Query parameters

pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Example response

{
  "items": [
    {
      "createdAt": "2024-01-01T01:01:01.001Z",
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "listing": {
        "capabilities": [
          {
            "description": "Stripe Tax calculates tax portion of the invoices.",
            "key": "stripe_calculate_tax",
            "name": "Calculate Tax",
            "type": "calculateTax"
          },
          {
            "description": "Stripe invoices customers with due amount.",
            "key": "stripe_invoice_customers",
            "name": "Invoice Customers",
            "type": "invoiceCustomers"
          },
          {
            "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method.",
            "key": "stripe_collect_payments",
            "name": "Collect Payments",
            "type": "collectPayments"
          }
        ],
        "description": "Stripe integration allows you to collect payments with Stripe.",
        "installMethods": [
          "with_oauth2",
          "with_api_key"
        ],
        "name": "Stripe",
        "type": "stripe"
      },
      "livemode": true,
      "maskedAPIKey": "sk_live_************abc",
      "name": "Stripe",
      "status": "ready",
      "stripeAccountId": "acct_123456789",
      "type": "stripe",
      "updatedAt": "2024-01-01T01:01:01.001Z"
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalCount": 500
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.