List Articles
GET/v2/articles
API version
v2
Request method
GET
Operation ID
article-list-articles
Request
- customerIdstringdeprecated
not in use.
Example:"123e4567-e89b-12d3-a456-426614174000" - tagsarray of string
Filters articles that contain at least one of the specified tags (logical OR).
Example:[] - templateNamesarray of stringExample:
[] - articleIdsarray of stringExample:
["WH25-0007"] - orderablearray of string (one of: forbidden, internal, beta_testing, full, deprecated)
- namestringExample:
"Webhosting" - limitinteger (≥ 0)
The max count of resources to return in the list response.
- skipinteger
Number of items to skip. Should be multiple of
limit. - pageinteger (≥ 0)
Page to display.
skipandpageend up doing the same. If bothpageandskipare set, skip is used.
Responses
Response headers
- 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.
Format
application/json
Description
Object containing the list of Articles
- Array[
- *object
- addonsarray of object
- Array[
- *object
- hiddenboolean
Defines if the Addon should not be shown.
- keystring (≥ 1 characters)required
Unique key of the Addon.
- typestring
The type/category of the addon.
- valuestringrequired
Value of the Addon, e.g. configuration details, status, or modifier properties.
- valueMergeTypestring (one of: add, set)
Used if Articles are ordered as a batch.
]
- articleIdstring (≥ 3 characters)required
- attributesarray of object
- Array[
- *object
- customerEditableboolean
Used if there are custom configurations needed for an Order like a Server name.
- keystring (≥ 1 characters)required
- mergeTypestring (one of: add, set)
Used if Articles are ordered as a batch.
- readonlyboolean
Used if not need for an Order.
- requiredboolean
- unitstring
Used if Articles are ordered as a batch.
- valuestring
Will be ignored if customerEditable is set.
]
- balanceAddonKeystringdeprecated
- contractDurationInMonthnumber (≥ 0)required
- descriptionstring
- forcedInvoicingPeriodInMonthnumber (≥ 0)
If set, the Article will always be invoiced for the given months.
- hasIndependentContractPeriodboolean
Article has a contract period which is not dependent on the Contract Base Item.
- hideOnInvoiceboolean
Free Article that is not showing on Invoices.
- machineTypeobject
Resources for hosting Articles.
- cpustringrequired
- memorystringrequired
Memory in GiB
- namestringrequired
- 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
Monthly price in Eurocent
- tagsarray of object
- Array[
- *object
- descriptionstring (≥ 1 characters)
- hexColorstring (≥ 1 characters)
- idstring (≥ 1 characters)required
- namestring (≥ 1 characters)
]
- templateobjectrequired
- additionalArticlesarray of object
- Array[
- *object
- articleIdstring (≥ 1 characters)required
- infoobject
- articleNamestring
- articleTemplateNamestring
- fromArticleTemplateboolean
- maxArticleCountnumber
]
- addonsarray of object
- Array[
- *object
- hiddenboolean
Defines if the Addon should not be shown.
- keystring (≥ 1 characters)required
Unique key of the Addon.
- typestring
The type/category of the addon.
- valuestringrequired
Value of the Addon, e.g. configuration details, status, or modifier properties.
- valueMergeTypestring (one of: add, set)
Used if Articles are ordered as a batch.
]
- attributesarray of object
- Array[
- *object
- customerEditableboolean
Used if there are custom configurations needed for an Order like a Server name.
- keystring (≥ 1 characters)required
- mergeTypestring (one of: add, set)
Used if Articles are ordered as a batch.
- readonlyboolean
Used if not need for an Order.
- requiredboolean
- unitstring
Used if Articles are ordered as a batch.
- valuestring
Will be ignored if customerEditable is set.
]
- descriptionstring
- idstring (≥ 1 characters)required
- isManagedByDomainbooleanrequired
- isRecurringbooleanrequired
- 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
]
Content-Type: application/json
[
{
"addons": [
{
"hidden": true,
"key": "Varnish",
"type": "config",
"value": "noway",
"valueMergeType": "add"
}
],
"articleId": "WH25-0007",
"attributes": [
{
"customerEditable": true,
"key": "cpu",
"mergeType": "add",
"readonly": true,
"required": true,
"unit": "GHz",
"value": "4"
}
],
"contractDurationInMonth": 123,
"description": "Configure your perfect hosting",
"forcedInvoicingPeriodInMonth": 123,
"hasIndependentContractPeriod": true,
"hideOnInvoice": true,
"machineType": {
"cpu": "1",
"memory": "10",
"name": "psplus-shared"
},
"modifierArticles": [
{
"articleId": "string",
"info": {
"articleName": "Webhosting Speicherplatz",
"articleTemplateName": "Speicher für Hosting aller Art",
"fromArticleTemplate": true
},
"maxArticleCount": 123
}
],
"name": "Webhosting",
"orderable": "full",
"possibleArticleChanges": [
{
"articleId": "string",
"info": {
"articleName": "Webhosting",
"articleTemplateName": "Webhosting",
"fromArticleTemplate": true
}
}
],
"price": 1300,
"tags": [
{
"description": "CPU optimized",
"hexColor": "#ff0000",
"id": "58e39bbe-fcd1-4fde-887c-f49ff85b9df5",
"name": "cpu-optimized"
}
],
"template": {
"additionalArticles": [
{
"articleId": "WH25-0007",
"info": {
"articleName": "Webhosting",
"articleTemplateName": "Webhosting",
"fromArticleTemplate": true
},
"maxArticleCount": 10
}
],
"addons": [
{
"hidden": true,
"key": "Varnish",
"type": "config",
"value": "noway",
"valueMergeType": "add"
}
],
"attributes": [
{
"customerEditable": true,
"key": "cpu",
"mergeType": "add",
"readonly": true,
"required": true,
"unit": "GHz",
"value": "4"
}
],
"description": "Space-Storage",
"id": "054e27e4-d3ed-4ffc-a472-fbb74a6a2ec1",
"isManagedByDomain": true,
"isRecurring": true,
"modifierArticles": [
{
"articleId": "string",
"info": {
"articleName": "Webhosting Speicherplatz",
"articleTemplateName": "Speicher für Hosting aller Art",
"fromArticleTemplate": true
},
"maxArticleCount": 123
}
],
"name": "Speicher für Hosting aller Art",
"type": "miscellaneous"
}
}
]
{
"items": {
"properties": {
"addons": {
"items": {
"properties": {
"hidden": {
"description": "Defines if the Addon should not be shown.",
"type": "boolean"
},
"key": {
"description": "Unique key of the Addon.",
"example": "Varnish",
"minLength": 1,
"type": "string"
},
"type": {
"description": "The type/category of the addon.",
"example": "config",
"type": "string"
},
"value": {
"description": "Value of the Addon, e.g. configuration details, status, or modifier properties.",
"example": "noway",
"type": "string"
},
"valueMergeType": {
"description": "Used if Articles are ordered as a batch.",
"enum": [
"add",
"set"
],
"type": "string"
}
},
"required": [
"key",
"value"
],
"type": "object"
},
"type": "array"
},
"articleId": {
"example": "WH25-0007",
"minLength": 3,
"type": "string"
},
"attributes": {
"items": {
"properties": {
"customerEditable": {
"description": "Used if there are custom configurations needed for an Order like a Server name.",
"type": "boolean"
},
"key": {
"example": "cpu",
"minLength": 1,
"type": "string"
},
"mergeType": {
"description": "Used if Articles are ordered as a batch.",
"enum": [
"add",
"set"
],
"type": "string"
},
"readonly": {
"description": "Used if not need for an Order.",
"type": "boolean"
},
"required": {
"type": "boolean"
},
"unit": {
"description": "Used if Articles are ordered as a batch.",
"example": "GHz",
"type": "string"
},
"value": {
"description": "Will be ignored if customerEditable is set.",
"example": "4",
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"type": "array"
},
"balanceAddonKey": {
"deprecated": true,
"example": "inclusive_domains",
"type": "string"
},
"contractDurationInMonth": {
"example": 0,
"maximum": 42,
"minimum": 0,
"type": "number"
},
"description": {
"example": "Configure your perfect hosting",
"type": "string"
},
"forcedInvoicingPeriodInMonth": {
"description": "If set, the Article will always be invoiced for the given months.",
"example": 0,
"minimum": 0,
"type": "number"
},
"hasIndependentContractPeriod": {
"description": "Article has a contract period which is not dependent on the Contract Base Item.",
"type": "boolean"
},
"hideOnInvoice": {
"description": "Free Article that is not showing on Invoices.",
"type": "boolean"
},
"machineType": {
"description": "Resources for hosting Articles.",
"properties": {
"cpu": {
"example": "1",
"type": "string"
},
"memory": {
"description": "Memory in GiB",
"example": "10",
"type": "string"
},
"name": {
"example": "psplus-shared",
"type": "string"
}
},
"required": [
"name",
"cpu",
"memory"
],
"type": "object"
},
"modifierArticles": {
"items": {
"properties": {
"articleId": {
"minLength": 1,
"type": "string"
},
"info": {
"properties": {
"articleName": {
"example": "Webhosting Speicherplatz",
"type": "string"
},
"articleTemplateName": {
"example": "Speicher für Hosting aller Art",
"type": "string"
},
"fromArticleTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"maxArticleCount": {
"minimum": 1,
"type": "number"
}
},
"required": [
"articleId",
"maxArticleCount"
],
"type": "object"
},
"type": "array"
},
"name": {
"example": "Webhosting",
"minLength": 3,
"type": "string"
},
"orderable": {
"description": "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.",
"enum": [
"full",
"forbidden",
"internal",
"beta_testing",
"deprecated"
],
"type": "string"
},
"possibleArticleChanges": {
"items": {
"properties": {
"articleId": {
"minLength": 1,
"type": "string"
},
"info": {
"properties": {
"articleName": {
"example": "Webhosting",
"type": "string"
},
"articleTemplateName": {
"example": "Webhosting",
"type": "string"
},
"fromArticleTemplate": {
"type": "boolean"
}
},
"type": "object"
}
},
"required": [
"articleId"
],
"type": "object"
},
"type": "array"
},
"price": {
"description": "Monthly price in Eurocent",
"example": 1300,
"type": "number"
},
"tags": {
"items": {
"properties": {
"description": {
"example": "CPU optimized",
"minLength": 1,
"type": "string"
},
"hexColor": {
"example": "#ff0000",
"minLength": 1,
"type": "string"
},
"id": {
"example": "58e39bbe-fcd1-4fde-887c-f49ff85b9df5",
"minLength": 1,
"type": "string"
},
"name": {
"example": "cpu-optimized",
"minLength": 1,
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"template": {
"properties": {
"additionalArticles": {
"items": {
"properties": {
"articleId": {
"example": "WH25-0007",
"minLength": 1,
"type": "string"
},
"info": {
"properties": {
"articleName": {
"example": "Webhosting",
"type": "string"
},
"articleTemplateName": {
"example": "Webhosting",
"type": "string"
},
"fromArticleTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"maxArticleCount": {
"example": 10,
"type": "number"
}
},
"required": [
"articleId"
],
"type": "object"
},
"type": "array"
},
"addons": {
"items": {
"properties": {
"hidden": {
"description": "Defines if the Addon should not be shown.",
"type": "boolean"
},
"key": {
"description": "Unique key of the Addon.",
"example": "Varnish",
"minLength": 1,
"type": "string"
},
"type": {
"description": "The type/category of the addon.",
"example": "config",
"type": "string"
},
"value": {
"description": "Value of the Addon, e.g. configuration details, status, or modifier properties.",
"example": "noway",
"type": "string"
},
"valueMergeType": {
"description": "Used if Articles are ordered as a batch.",
"enum": [
"add",
"set"
],
"type": "string"
}
},
"required": [
"key",
"value"
],
"type": "object"
},
"type": "array"
},
"attributes": {
"items": {
"properties": {
"customerEditable": {
"description": "Used if there are custom configurations needed for an Order like a Server name.",
"type": "boolean"
},
"key": {
"example": "cpu",
"minLength": 1,
"type": "string"
},
"mergeType": {
"description": "Used if Articles are ordered as a batch.",
"enum": [
"add",
"set"
],
"type": "string"
},
"readonly": {
"description": "Used if not need for an Order.",
"type": "boolean"
},
"required": {
"type": "boolean"
},
"unit": {
"description": "Used if Articles are ordered as a batch.",
"example": "GHz",
"type": "string"
},
"value": {
"description": "Will be ignored if customerEditable is set.",
"example": "4",
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"type": "array"
},
"description": {
"example": "Space-Storage",
"type": "string"
},
"id": {
"example": "054e27e4-d3ed-4ffc-a472-fbb74a6a2ec1",
"minLength": 1,
"type": "string"
},
"isManagedByDomain": {
"type": "boolean"
},
"isRecurring": {
"type": "boolean"
},
"modifierArticles": {
"items": {
"properties": {
"articleId": {
"minLength": 1,
"type": "string"
},
"info": {
"properties": {
"articleName": {
"example": "Webhosting Speicherplatz",
"type": "string"
},
"articleTemplateName": {
"example": "Speicher für Hosting aller Art",
"type": "string"
},
"fromArticleTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"maxArticleCount": {
"minimum": 1,
"type": "number"
}
},
"required": [
"articleId",
"maxArticleCount"
],
"type": "object"
},
"type": "array"
},
"name": {
"example": "Speicher für Hosting aller Art",
"minLength": 3,
"type": "string"
},
"type": {
"enum": [
"miscellaneous",
"base",
"additional",
"modifier",
"setup_fee"
],
"type": "string"
}
},
"required": [
"id",
"name",
"isRecurring",
"type",
"isManagedByDomain"
],
"type": "object"
}
},
"required": [
"articleId",
"name",
"contractDurationInMonth",
"orderable",
"template"
],
"type": "object"
},
"type": "array"
}
Format
application/json
Description
Your request ran into a rate limit. You have to wait until rate limit expires
- messagestring
- typestring
Content-Type: application/json
{
"message": "too many requests",
"type": "RateLimitError"
}
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "too many requests"
},
"type": {
"type": "string",
"example": "RateLimitError"
}
}
}
Format
application/json
Description
An unexpected Error that occurred while handling the request
- messagestringrequired
- typestringrequired
Content-Type: application/json
{
"message": "Something went wrong",
"type": "InternalServerError"
}
{
"type": "object",
"required": [
"type",
"message"
],
"properties": {
"message": {
"type": "string",
"example": "Something went wrong"
},
"type": {
"type": "string",
"example": "InternalServerError"
}
}
}
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
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.article.listArticles({
"queryParameters": {
"customerId": "string",
"tags": [
"string"
],
"templateNames": [
"string"
],
"articleIds": [
"string"
],
"orderable": [
"forbidden"
],
"name": "string",
"limit": 50,
"page": 1
}
});
assertStatus(response, 200);
use \Mittwald\ApiClient\Generated\V2\Clients\Article\ListArticles\ListArticlesRequest;
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));
$request = (new ListArticlesRequest())
->withCustomerId("string")
->withTags(["string"])
->withTemplateNames(["string"])
->withArticleIds(["string"])
->withOrderable(["forbidden"])
->withName("string")
->withLimit(50)
->withPage(1);
$response = $client->article()->listArticles($request);
var_dump($response->getBody();