Skip to main content
GET
Get a preference (staff)

Authorizations

Authorization
string
header
required

Path Parameters

id
string<uuid>
required

A UUID string identifying this preference.

Response

200 - application/json
id
string<uuid>
required
read-only
group_id
string<uuid>
required
key
string
required

Stable identifier used by the front-end.

Maximum string length: 100
Pattern: ^[-a-zA-Z0-9_]+$
name
string
required
Maximum string length: 255
value_type
enum<string>
required
  • boolean - Boolean
  • integer - Integer
  • string - String
  • choice - Choice
Available options:
boolean,
integer,
string,
choice
default_value
any
required
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
description
string
choices
any[] | null
readonly
boolean

Only administrators can set a value; users can read it but not change it.

order
integer
Required range: 0 <= x <= 2147483647