List Extensions

GET/extensions/

API version

v2

Request method

GET

Operation ID

extension-list-extensions

---

Request

Responses

Format

application/json

Description

OK

Schema documentation

• 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

        required
      • idstring (uuid)

        required

        The asset ID and reference ID to its file. Retrieve the file with this id on `/v2/files/{id}

      • indexinteger (≥ 0)

        required
    ]
• blockedboolean

  required
• contextstring (one of: project, customer)

  required
• contributorIdstring (uuid)

  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

  required
• externalFrontendsarray of object
  • Array[
  • *object
    • namestring

      required
    • urlstring

      required
  ]

frontendComponentsarray of object

• Array[
• *object
  • namestring

    required
  • urlstring

    required
]

frontendFragmentsobject

• *

idstring (uuid)

required

logoRefIdstring (uuid)

This is the FileId of the Logo. Retrieve the file with this id on /v2/files/{logoRefId}.

namestring

required

publishedboolean

required

Whether the extension has been published by the contributor.

scopesarray of string

required

• Array[
• *string
]

statestring (one of: enabled, blocked, disabled)

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)

supportobject

required

• emailstring
• phonestring

tagsarray of string

required

• Array[
• *string
]

]

Example

[
  {
    "assets": [
      {
        "assetType": "image",
        "fileName": "myFile.png",
        "id": "f0f86186-0a5a-45b2-aa33-502777496347",
        "index": 123
      }
    ],
    "blocked": true,
    "context": "project",
    "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "deprecation": {
      "deprecatedAt": "2025-03-09T00:27:04.502Z",
      "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"
      }
    },
    "disabled": true,
    "externalFrontends": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "frontendComponents": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "frontendFragments": {
      "string": null
    },
    "id": "f0f86186-0a5a-45b2-aa33-502777496347",
    "logoRefId": "f0f86186-0a5a-45b2-aa33-502777496347",
    "name": "MyPingExtension",
    "published": true,
    "scopes": [
      "string"
    ],
    "state": "enabled",
    "statistics": {
      "amountOfInstances": 42
    },
    "subTitle": {
      "de": "Ping deine App an",
      "en": "Ping your app"
    },
    "support": {
      "email": "a.lovelace@example.com",
      "phone": "string"
    },
    "tags": [
      "string"
    ]
  }
]

JSON Schema

{
  "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": {
              "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": {
              "example": 0,
              "maximum": 3,
              "minimum": 0,
              "type": "integer"
            }
          },
          "required": [
            "id",
            "fileName",
            "index",
            "assetType"
          ],
          "type": "object"
        },
        "maxItems": 4,
        "type": "array"
      },
      "blocked": {
        "deprecated": true,
        "type": "boolean"
      },
      "context": {
        "enum": [
          "project",
          "customer"
        ],
        "type": "string"
      },
      "contributorId": {
        "format": "uuid",
        "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": {
        "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"
      },
      "published": {
        "description": "Whether the extension has been published by the contributor.",
        "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": {
        "properties": {
          "email": {
            "example": "a.lovelace@example.com",
            "type": "string"
          },
          "phone": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "tags": {
        "items": {
          "type": "string"
        },
        "minItems": 0,
        "type": "array"
      }
    },
    "required": [
      "id",
      "contributorId",
      "support",
      "state",
      "published",
      "name",
      "subTitle",
      "description",
      "tags",
      "context",
      "scopes",
      "disabled",
      "blocked",
      "assets",
      "statistics"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extensions?context=project&limit=50&page=1

JavaScript SDK

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",
    "limit": 50,
    "page": 1
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ExtensionListExtensionsRequest())
  ->withContext("project")
  ->withLimit(50)
  ->withPage(1);
$response = $client->marketplace()->extensionListExtensions($request);

var_dump($response->getBody();