List articles from the article catalogue, optionally filtered and paginated

Includes inactive articles unless the filter excludes them.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/articles

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/articles' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.

Response

{
  "data": [
    {
      "id": 1,
      "article_number": "ART-001",
      "name": "EU",
      "unit": "Stunde",
      "unit_price": 1.5,
      "currency": "EUR",
      "description": "Angebot|en:offer",
      "inactive": false,
      "description_en": "Professional consulting services",
      "description_fr": "Développement de logiciels",
      "description_es": "string",
      "description_pl": "string",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

Name
id
Type
integer
Description
The article’s unique identifier.
Name
article_number
Type
string, nullable
Description
The article number used to reference this article externally.
Name
name
Type
string, nullable
Description
The article’s name, as shown on invoices and price lists.
Name
unit
Type
string, nullable
Description
The unit this article is priced and billed in, e.g. piece or hour.
Name
unit_price
Type
number, nullable
Description
The article’s price per unit, in the given currency.
Name
currency
Type
string, nullable
Description
The three-letter currency code unit_price is stated in.
Name
description
Type
string, nullable
Description
The article’s default description text, in the tenant’s primary language.
Name
inactive
Type
boolean
Description
Whether the article has been deactivated and is hidden from new selections.
Name
description_en
Type
string, nullable
Description
The article’s description text in English, for multilingual invoices.
Name
description_fr
Type
string, nullable
Description
The article’s description text in French, for multilingual invoices.
Name
description_es
Type
string, nullable
Description
The article’s description text in Spanish, for multilingual invoices.
Name
description_pl
Type
string, nullable
Description
The article’s description text in Polish, for multilingual invoices.
Name
created
Type
string (date-time), nullable
Description
When the article record was first created.
Name
modified
Type
string (date-time), nullable
Description
When the article record was last changed.

Generated from the OpenAPI specification — edit the source code, not this page.

Articles GET Get a single article by its id