Sign in
latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

Allowance Management

List all allowance types

Returns every allowance type of the workspace, in the order they are shown in the app. The ids returned here are the allowance_type_id every rule, rule assignment and adjustment endpoint expects.

get/allowance-types

Query parameters

locale'en' | 'de' | 'fr' | 'hu' | 'it' | 'pl' | 'pt' | 'ru' | 'es' | 'tr' | 'uk'

Response

Successful response

idstring required
namestring required

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_namestring required

The stored name, without any translation applied.

allowance_unit'days' | 'hours' required

Whether this type is counted in days or in minutes.

ignore_allowance_limitboolean required

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

default_rule_idstring nullable required

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

workspace_idstring required
createdAtstring required
updatedAtstring required