Skip to main content
GET
Read an allowance type

Autorisierungen

X-API-KEY
string
header
erforderlich

Pfadparameter

id
string<uuid>
erforderlich
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Abfrageparameter

locale
enum<string>
Verfügbare Optionen:
en,
de,
fr,
hu,
it,
pl,
pt,
ru,
es,
tr,
uk

Antwort

Successful response

id
string
erforderlich
name
string
erforderlich

Translated into locale when one is given, otherwise into the API key owner's language, falling back to the stored name where no translation exists.

default_name
string
erforderlich

The stored name, without any translation applied.

allowance_unit
enum<string>
erforderlich

Whether this type is counted in days or in minutes.

Verfügbare Optionen:
days,
hours
ignore_allowance_limit
boolean
erforderlich

When true, members may book more than their balance and go negative.

default_rule_id
string | null
erforderlich

The rule a new member of this workspace is put on. A department default rule takes precedence over it.

default_rule_manually_managed
boolean
erforderlich

When true, new members are managed manually unless their department selects a rule.

workspace_id
string
erforderlich
createdAt
string
erforderlich
updatedAt
string
erforderlich
translations
object[]
erforderlich
leave_types
object[]
erforderlich

The leave types that draw from this allowance type.