List price groups, optionally filtered and paginated

Includes inactive price groups unless the filter excludes them.

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

Request

GET /api/v1/price-groups

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/price-groups' \
     --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,
      "name": "EU",
      "number": "string",
      "status": true,
      "description": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "es": "string",
        "pl": "string"
      }
    }
  ],
  "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 price group’s unique identifier.
Name
name
Type
string
Description
The price group’s name, as shown when assigning it to a customer or project.
Name
number
Type
string, nullable
Description
The price group’s number, used to reference it externally.
Name
status
Type
boolean
Description
Whether the price group is active; the underlying column is stored inverted, true here means active.
Name
description
Type
object
Description
The price group’s description, published as a per-language structure (i18n) rather than a plain string.
Name
description.de
Type
string, nullable
Description
Name
description.en
Type
string
Description
Name
description.fr
Type
string
Description
Name
description.es
Type
string
Description
Name
description.pl
Type
string
Description

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

Price Groups GET Get a single price group by its id