Get an Extension
GET/v2/ extensions/ {extensionId}/
API version
v2
Request method
GET
Operation ID
extension-get-extension
Request
- extensionIdstring (uuid)required
Responses
Format
application/json
Description
OK
- Schema documentation
- Example
- JSON Schema
- *
Content-Type: application/json
null
{
"anyOf": [
{
"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"
},
"deletionDeadline": {
"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 capabilities 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"
},
"isDeletionScheduled": {
"type": "boolean"
},
"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"
},
{
"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"
},
"deletionDeadline": {
"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 capabilities 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": {
"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"
},
"isDeletionScheduled": {
"type": "boolean"
},
"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": [
false
],
"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"
},
"type": "array"
}
},
"required": [
"id",
"contributorId",
"state",
"name",
"tags",
"context",
"scopes",
"disabled",
"blocked",
"assets",
"statistics"
],
"type": "object"
}
]
}
Usage examples
- cURL
- JavaScript SDK
- PHP SDK
$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/extensions/f0f86186-0a5a-45b2-aa33-502777496347
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.extensionGetExtension({
"extensionId": "f0f86186-0a5a-45b2-aa33-502777496347"
});
assertStatus(response, 200);
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionGetExtension\ExtensionGetExtensionRequest;
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));
$request = (new ExtensionGetExtensionRequest(
extensionId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->extensionGetExtension($request);
var_dump($response->getBody();