Zum Hauptinhalt springen

List Articles

GET/articles/
v2
GET
article-list-articles

Request​

Responses​

Response-Header

  • X-Pagination-Limitinteger

    The limit used to select the resources for the response

  • X-Pagination-Skipinteger

    The number of skipped items

  • X-Pagination-Pagenumber

    The calculate page of the list response. Refer to parameters to learn more.

  • X-Pagination-TotalCountinteger

    The total amount of items available in the remote ressource. Use this value in combination with the limit to calculate the available pages.

application/json

Object containing the list of Articles

  • Array[
    • *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: full, forbidden, internal, beta_testing, deprecated)
        required

        Only Articles with the value 'full' can be ordered by everyone. Forbidden Articles are not allowed to be ordered. Internal Articles have to be ordered by a mittwald employee. Beta testing Articles can be ordered but maybe feature incomplete. Deprecated Articles are not orderable anymore.

      • 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?customerId=string&tags=string&templateNames=string&articleIds=string&orderable=forbidden&name=string&limit=50&page=1