curl --request GET \
--url http:localhost:3000/v2/articles/ \
--header 'x-API-Key: <api-key>'
[
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"type": "ARTICLE",
"name": "<string>",
"price": 123,
"unit": "<string>",
"description": "<string>",
"numberExtern": "<string>",
"prices": [
{
"sellPrice": 19.99,
"buyPrice": 15,
"currency": "EUR",
"tax": 0.19,
"taxRateId": "60c72b2f9b1e8d3f4c8b4567",
"comment": "<string>"
}
],
"bookingAccountNumber": "<string>",
"skontoBookingAccountNumber": "<string>",
"comment": "<string>",
"attachmentIds": [
"<string>"
],
"articleDescription": "<string>",
"imageUrl": "<string>",
"groupId": "<string>",
"supplierId": "<string>",
"priority": 123,
"inStock": 123,
"minimumInStock": 123
}
]
Get a list of all articles. Supports filtering, pagination, and sorting.
curl --request GET \
--url http:localhost:3000/v2/articles/ \
--header 'x-API-Key: <api-key>'
[
{
"_id": "<string>",
"number": 123,
"companyId": "<string>",
"status": {
"status": 123,
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"lastModifiedAt": "2023-11-07T05:31:56Z",
"lastModifiedBy": "<string>"
},
"chatId": "<string>",
"type": "ARTICLE",
"name": "<string>",
"price": 123,
"unit": "<string>",
"description": "<string>",
"numberExtern": "<string>",
"prices": [
{
"sellPrice": 19.99,
"buyPrice": 15,
"currency": "EUR",
"tax": 0.19,
"taxRateId": "60c72b2f9b1e8d3f4c8b4567",
"comment": "<string>"
}
],
"bookingAccountNumber": "<string>",
"skontoBookingAccountNumber": "<string>",
"comment": "<string>",
"attachmentIds": [
"<string>"
],
"articleDescription": "<string>",
"imageUrl": "<string>",
"groupId": "<string>",
"supplierId": "<string>",
"priority": 123,
"inStock": 123,
"minimumInStock": 123
}
]
1 <= x <= 1000
x >= 0
List of articles
The response is of type Article · object[]
.
Was this page helpful?