List Extensions

GET/extensions/

API version

Request method

GET

Operation ID

extension-list-extensions

Request

Responses

Response-Header

X-Pagination-Limitinteger
The limit used to select the resources for the response
X-Pagination-Skipinteger
The number of skipped items
X-Pagination-Pagenumber
The calculate page of the list response. Refer to parameters to learn more.
X-Pagination-TotalCountinteger
The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

Format

application/json

Beschreibung

Schema-Dokumentation
Beispiel
JSON Schema

Array[
- *object
  - assetsarray of object
    required
    The assets/media (images and videos) of the extension.
    - Array[
      The following assets are the media that are associated with the extension and will be shown in extension details page.
      - *object
        The following assets are the media that are associated with the extension and will be shown in extension details page.
        assetTypestring (one of: image, video)
        required
        fileNamestring
        deprecated
        idstring (uuid)
        required
        The asset ID and reference ID to its file. Retrieve the file with this id on `/v2/files/{id}
        indexinteger
        required
        The index of the asset. Does not have to be successive. Can be used to order the assets.
      ]
  - blockedboolean
    deprecated
    required
  - contextstring (one of: project, customer)
    required
  - contributorIdstring (uuid)
    required
  - createdAtstring (date-time)
    required
  - deprecationobject
    The Extension is deprecated by the contributor and will expire at the given date.
    - deprecatedAtstring (date-time)
      required
    - notestring
    - successorIdstring (uuid)
      The ID of the successor extension.
  - descriptionstring
    required
    A short description of the capabilites of the Extension.
  - detailedDescriptionsobject
    A detailed description of the capabilities of the extension.
    - deobject
      required
      Language specific descriptions in various formats.
      - markdownstring (≥ 1 characters)
        required
      - plainstring (≥ 1 characters)
    - enobject
      Language specific descriptions in various formats.
      - markdownstring (≥ 1 characters)
        required
      - plainstring (≥ 1 characters)
  - disabledboolean
    deprecated
    required
  - externalFrontendsarray of object
    - Array[
      - *object
        namestring
        required
        urlstring
        required
      ]
  - frontendComponentsarray of object
    deprecated
    - Array[
      - *object
        namestring
        required
        urlstring
        required
      ]
  - frontendFragmentsobject
    - *
  - idstring (uuid)
    required
  - logoRefIdstring (uuid)
    required
    This is the FileId of the Logo. Retrieve the file with this id on /v2/files/{logoRefId}.
  - namestring
    required
  - pricingone of 1 alternatives
    - Alternativearray of object
      A price plan with (multiple) variants, including different prices for different included service descriptions
      - Array[
        *object
        deletionDeadlinestring (date-time)
        descriptionstring
        isBookingStoppedboolean
        required
        If a variant is no longer bookable the existing extension instances will not be removed but no new ones can be created.
        isDeletionScheduledboolean
        required
        keystring
        required
        namestring
        priceInCentsinteger
        required
        The monthly price in Euro Cents before tax.
        ]
  - pricingDetailsobject
    The details section of the price plan. It informs if choosing different variants as a upgrade or downgrade is possible.
    - isDowngradeAllowedboolean
      required
    - isUpgradeAllowedboolean
      required
  - publishedboolean (one of: true)
    required
    Whether the extension has been published by the contributor.
  - scopesarray of string
    required
    - Array[
      - *string
      ]
  - statestring (one of: enabled, blocked, disabled)
    deprecated
    required
    deprecated
  - statisticsobject
    required
    - amountOfInstancesinteger (≥ 0)
      The amout of instances for this extension. Accurate for the Contributor. Publicly rounded to the next lower hundred.
  - subTitleobject
    required
    A few words to promote your Extension.
    - destring (≤ 40 characters)
      required
    - enstring (≤ 40 characters)
  - support
    required
  - tagsarray of string
    required
    - Array[
      - *string
      ]
]

Content-Type: application/json

[
  {
    "assets": [
      {
        "assetType": "image",
        "id": "f0f86186-0a5a-45b2-aa33-502777496347",
        "index": 1
      }
    ],
    "context": "project",
    "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "createdAt": "1985-10-26T01:21:00.000Z",
    "deprecation": {
      "deprecatedAt": "1985-10-26T01:21:00.000Z",
      "note": "This extension is no longer actively maintained. Please Use the successor extension instead.",
      "successorId": "f0f86186-0a5a-45b2-aa33-502777496347"
    },
    "description": "string",
    "detailedDescriptions": {
      "de": {
        "markdown": "string",
        "plain": "string"
      },
      "en": {
        "markdown": "string",
        "plain": "string"
      }
    },
    "externalFrontends": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "frontendFragments": {
      "string": null
    },
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "logoRefId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "name": "MyPingExtension",
    "pricing": [
      {
        "deletionDeadline": "1985-10-26T01:21:00.000Z",
        "description": "string",
        "isBookingStopped": true,
        "isDeletionScheduled": true,
        "key": "string",
        "name": "string",
        "priceInCents": 123
      }
    ],
    "pricingDetails": {
      "isDowngradeAllowed": true,
      "isUpgradeAllowed": true
    },
    "published": true,
    "scopes": [
      "string"
    ],
    "statistics": {
      "amountOfInstances": 42
    },
    "subTitle": {
      "de": "Ping deine App an",
      "en": "Ping your app"
    },
    "support": null,
    "tags": [
      "string"
    ]
  }
]

{
  "items": {
    "properties": {
      "assets": {
        "description": "The assets/media (images and videos) of the extension.",
        "items": {
          "description": "The following assets are the media that are associated with the extension and will be shown in extension details page.",
          "properties": {
            "assetType": {
              "enum": [
                "image",
                "video"
              ],
              "example": "image",
              "type": "string"
            },
            "fileName": {
              "deprecated": true,
              "example": "myFile.png",
              "type": "string"
            },
            "id": {
              "description": "The asset ID and reference ID to its file. Retrieve the file with this id on `/v2/files/{id}",
              "format": "uuid",
              "type": "string"
            },
            "index": {
              "description": "The index of the asset. Does not have to be successive. Can be used to order the assets.",
              "example": 1,
              "type": "integer"
            }
          },
          "required": [
            "id",
            "index",
            "assetType"
          ],
          "type": "object"
        },
        "maxItems": 4,
        "type": "array"
      },
      "blocked": {
        "deprecated": true,
        "type": "boolean"
      },
      "context": {
        "enum": [
          "project",
          "customer"
        ],
        "type": "string"
      },
      "contributorId": {
        "format": "uuid",
        "type": "string"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "deprecation": {
        "description": "The Extension is deprecated by the contributor and will expire at the given date.",
        "properties": {
          "deprecatedAt": {
            "format": "date-time",
            "type": "string"
          },
          "note": {
            "example": "This extension is no longer actively maintained. Please Use the successor extension instead.",
            "type": "string"
          },
          "successorId": {
            "description": "The ID of the successor extension.",
            "format": "uuid",
            "type": "string"
          }
        },
        "required": [
          "deprecatedAt"
        ],
        "type": "object"
      },
      "description": {
        "description": "A short description of the capabilites of the Extension.",
        "type": "string"
      },
      "detailedDescriptions": {
        "description": "A detailed description of the capabilities of the extension.",
        "properties": {
          "de": {
            "description": "Language specific descriptions in various formats.",
            "properties": {
              "markdown": {
                "minLength": 1,
                "type": "string"
              },
              "plain": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "markdown"
            ],
            "type": "object"
          },
          "en": {
            "description": "Language specific descriptions in various formats.",
            "properties": {
              "markdown": {
                "minLength": 1,
                "type": "string"
              },
              "plain": {
                "minLength": 1,
                "type": "string"
              }
            },
            "required": [
              "markdown"
            ],
            "type": "object"
          }
        },
        "required": [
          "de"
        ],
        "type": "object"
      },
      "disabled": {
        "deprecated": true,
        "type": "boolean"
      },
      "externalFrontends": {
        "items": {
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "name",
            "url"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "frontendComponents": {
        "deprecated": true,
        "items": {
          "properties": {
            "name": {
              "type": "string"
            },
            "url": {
              "type": "string"
            }
          },
          "required": [
            "name",
            "url"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "frontendFragments": {
        "additionalProperties": {
          "allOf": [
            {
              "properties": {
                "additionalProperties": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                }
              },
              "type": "object"
            },
            {
              "oneOf": [
                {
                  "properties": {
                    "url": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "url"
                  ],
                  "type": "object"
                }
              ]
            }
          ]
        },
        "type": "object"
      },
      "id": {
        "format": "uuid",
        "type": "string"
      },
      "logoRefId": {
        "description": "This is the FileId of the Logo. Retrieve the file with this id on `/v2/files/{logoRefId}`.",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "example": "MyPingExtension",
        "type": "string"
      },
      "pricing": {
        "oneOf": [
          {
            "description": "A price plan with (multiple) variants, including different prices for different included service descriptions",
            "items": {
              "properties": {
                "deletionDeadline": {
                  "format": "date-time",
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "isBookingStopped": {
                  "description": "If a variant is no longer bookable the existing extension instances will not be removed but no new ones can be created.",
                  "type": "boolean"
                },
                "isDeletionScheduled": {
                  "type": "boolean"
                },
                "key": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "priceInCents": {
                  "description": "The monthly price in Euro Cents before tax.",
                  "type": "integer"
                }
              },
              "required": [
                "key",
                "priceInCents",
                "isBookingStopped",
                "isDeletionScheduled"
              ],
              "type": "object"
            },
            "type": "array"
          }
        ]
      },
      "pricingDetails": {
        "description": "The details section of the price plan. It informs if choosing different variants as a upgrade or downgrade is possible.",
        "properties": {
          "isDowngradeAllowed": {
            "type": "boolean"
          },
          "isUpgradeAllowed": {
            "type": "boolean"
          }
        },
        "required": [
          "isUpgradeAllowed",
          "isDowngradeAllowed"
        ],
        "type": "object"
      },
      "published": {
        "description": "Whether the extension has been published by the contributor.",
        "enum": [
          true
        ],
        "type": "boolean"
      },
      "scopes": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "state": {
        "deprecated": true,
        "description": "deprecated",
        "enum": [
          "enabled",
          "blocked",
          "disabled"
        ],
        "type": "string"
      },
      "statistics": {
        "properties": {
          "amountOfInstances": {
            "description": "The amout of instances for this extension. Accurate for the Contributor. Publicly rounded to the next lower hundred.",
            "example": 42,
            "minimum": 0,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "subTitle": {
        "description": "A few words to promote your Extension.",
        "properties": {
          "de": {
            "example": "Ping deine App an",
            "maxLength": 40,
            "type": "string"
          },
          "en": {
            "example": "Ping your app",
            "maxLength": 40,
            "type": "string"
          }
        },
        "required": [
          "de"
        ],
        "type": "object"
      },
      "support": {
        "allOf": [
          {
            "properties": {
              "email": {
                "example": "a.lovelace@example.com",
                "format": "email",
                "type": "string"
              },
              "phone": {
                "type": "string"
              }
            },
            "required": [
              "email"
            ],
            "type": "object"
          },
          {
            "properties": {
              "inherited": {
                "description": "Whether the support information is inherited from the contributor.",
                "type": "boolean"
              }
            },
            "required": [
              "inherited"
            ],
            "type": "object"
          }
        ]
      },
      "tags": {
        "items": {
          "type": "string"
        },
        "minItems": 0,
        "type": "array"
      }
    },
    "required": [
      "id",
      "contributorId",
      "state",
      "published",
      "name",
      "subTitle",
      "description",
      "tags",
      "context",
      "scopes",
      "disabled",
      "blocked",
      "assets",
      "statistics",
      "support",
      "logoRefId",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL
JavaScript SDK
PHP SDK

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extensions?context=project&searchTerm=string&includeDeprecated=true&limit=50&page=1&sort=name&order=asc

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionListExtensions({
  "queryParameters": {
    "context": "project",
    "searchTerm": "string",
    "includeDeprecated": true,
    "limit": 50,
    "page": 1,
    "sort": "name",
    "order": "asc"
  }
});

assertStatus(response, 200);
  

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionListExtensions\ExtensionListExtensionsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ExtensionListExtensionsRequest())
  ->withContext("project")
  ->withSearchTerm("string")
  ->withIncludeDeprecated(true)
  ->withLimit(50)
  ->withPage(1)
  ->withSort("name")
  ->withOrder("asc");
$response = $client->marketplace()->extensionListExtensions($request);

var_dump($response->getBody();
  

Request​

Query-Parameter

Responses​

200 OK

Response-Header

429 Too Many Requests

default

Usage examples​

Request

Responses

Usage examples