Skip to main content

Get an Article

GET/articles/{articleId}/
v2
GET
article-get-article

Request

  • articleIdstring
    required
    Example:"PS23-PLUS-0004"

Responses

application/json

The Article object

  • addonsarray of object
    • Array[
    • *object
      • hiddenboolean
      • keystring (≥ 1 characters)
        required
      • typestring
      • valuestring
        required
      • valueMergeTypestring (one of: add, set)
    • ]
  • articleIdstring (≥ 3 characters)
    required
  • attributesarray of object
    • Array[
    • *object
      • customerEditableboolean
      • keystring (≥ 1 characters)
        required
      • mergeTypestring (one of: add, set)
      • readonlyboolean
      • requiredboolean
      • unitstring
      • valuestring
    • ]
  • balanceAddonKeystring
  • contractDurationInMonthnumber (≥ 0)
    required
  • descriptionstring
  • forcedInvoicingPeriodInMonthnumber (≥ 0)
  • hasIndependentContractPeriodboolean
  • hideOnInvoiceboolean
  • machineTypeobject
    • cpustring
      required
    • memorystring
      required
    • namestring
      required
  • modifierArticlesarray of object
    • Array[
    • *object
      • articleIdstring (≥ 1 characters)
        required
      • infoobject
        • articleNamestring
        • articleTemplateNamestring
        • fromArticleTemplateboolean
      • maxArticleCountnumber (≥ 1)
        required
    • ]
  • namestring (≥ 3 characters)
    required
  • orderablestring (one of: forbidden, internal, beta_testing, full, deprecated)
    required
  • possibleArticleChangesarray of object
    • Array[
    • *object
      • articleIdstring (≥ 1 characters)
        required
      • infoobject
        • articleNamestring
        • articleTemplateNamestring
        • fromArticleTemplateboolean
    • ]
  • pricenumber
  • tagsarray of object
    • Array[
    • *object
      • descriptionstring (≥ 1 characters)
      • hexColorstring (≥ 1 characters)
      • idstring (≥ 1 characters)
        required
      • namestring (≥ 1 characters)
    • ]
  • templateobject
    required
    • additionalArticlesarray of object
      • Array[
      • *object
        • articleIdstring (≥ 1 characters)
          required
        • infoobject
          • articleNamestring
          • articleTemplateNamestring
          • fromArticleTemplateboolean
        • maxArticleCountnumber
      • ]
    • addonsarray of object
      • Array[
      • *object
        • hiddenboolean
        • keystring (≥ 1 characters)
          required
        • typestring
        • valuestring
          required
        • valueMergeTypestring (one of: add, set)
      • ]
    • attributesarray of object
      • Array[
      • *object
        • customerEditableboolean
        • keystring (≥ 1 characters)
          required
        • mergeTypestring (one of: add, set)
        • readonlyboolean
        • requiredboolean
        • unitstring
        • valuestring
      • ]
    • descriptionstring
    • idstring (≥ 1 characters)
      required
    • isManagedByDomainboolean
      required
    • isRecurringboolean
      required
    • modifierArticlesarray of object
      • Array[
      • *object
        • articleIdstring (≥ 1 characters)
          required
        • infoobject
          • articleNamestring
          • articleTemplateNamestring
          • fromArticleTemplateboolean
        • maxArticleCountnumber (≥ 1)
          required
      • ]
    • namestring (≥ 3 characters)
      required
    • typestring (one of: miscellaneous, base, additional, modifier, setup_fee)
      required

Usage examples

$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/articles/string?customerId=string