Get a single price group by its id

Returns the price group’s own data; the customers or projects assigned to it are not embedded.

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

Request

GET /api/v1/price-groups/{id}

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

Path parameters

Name
id
Type
integer
Description
The price group ID

Response

{
  "data": {
    "id": 1,
    "name": "EU",
    "number": "string",
    "status": true,
    "description": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "es": "string",
      "pl": "string"
    }
  }
}

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.

GET List price groups, optionally filtered and paginated Locations