Get an Extension

GET/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

• 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
• descriptionstring

  required
• detailedDescriptionsobject

  Supported languages. Format ISO-639-1.

  • 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
• frontendComponentsarray of object
  • Array[
  • *object
    • namestring

      required
    • urlstring

      required
  ]

frontendFragmentsobject

• *one of 1 alternatives

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

supportobject

required

• emailstring
• phonestring

tagsarray of string

required

• Array[
• *string
]

Example

{
  "blocked": true,
  "context": "project",
  "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "deprecation": {
    "deprecatedAt": "2024-12-21T00:27:37.069Z"
  },
  "description": "string",
  "detailedDescriptions": {
    "de": {
      "markdown": "string",
      "plain": "string"
    },
    "en": {
      "markdown": "string",
      "plain": "string"
    }
  },
  "disabled": true,
  "frontendComponents": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "frontendFragments": {
    "string": {
      "url": "string"
    }
  },
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "logoRefId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "name": "string",
  "published": true,
  "scopes": [
    "string"
  ],
  "state": "enabled",
  "support": {
    "email": "a.lovelace@example.com",
    "phone": "string"
  },
  "tags": [
    "string"
  ]
}

JSON Schema

{
  "properties": {
    "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"
        }
      },
      "required": [
        "deprecatedAt"
      ],
      "type": "object"
    },
    "description": {
      "type": "string"
    },
    "detailedDescriptions": {
      "description": "Supported languages. Format ISO-639-1.",
      "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"
    },
    "frontendComponents": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "url"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "frontendFragments": {
      "additionalProperties": {
        "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": {
      "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"
    },
    "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",
    "description",
    "tags",
    "context",
    "scopes",
    "disabled",
    "blocked"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extensions/f0f86186-0a5a-45b2-aa33-502777496347

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.extensionGetExtension({
  "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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();