Skip to main content

Get an Extension

GET/extensions/{extensionId}/
v2
GET
extension-get-extension

Request

  • extensionIdstring (uuid)
    required

Responses

application/json

OK

  • 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
    • ]
  • Usage examples

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