Sign in

v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
User Schema

Retrieve a user schema

Retrieves a user Schema.

get/v3/schema/users

Response

OK

slugstring
visibility'PUBLIC'
contextstring
labelstring
internal-descriptionstring
public-descriptionstring
requiredboolean
validation-expressionstring
input-type'text' | 'color' | 'number' | 'range' | 'time' | 'datetime' | 'date' | 'week' | 'month' | 'email' | 'tel' | 'url' | 'password' | 'select' | 'checkbox' | 'radio' | 'textarea' | 'hidden'
select-optionsstring
range-startnumber
range-endnumber
range-stepnumber
decision-pointboolean
publicly-writableboolean
form-useboolean
unitstring
unit-position'leading' | 'trailing'
value-precisionnumber
stat-direction'ascending' | 'descending'

Example response

[
  {
    "slug": "slug1",
    "visibility": "PUBLIC",
    "context": "slug1",
    "label": "Test",
    "internal-description": "This is for testing",
    "public-description": "Please provide some info",
    "validation-expression": "test",
    "input-type": "text",
    "select-options": "null",
    "range-end": 100,
    "range-step": 5,
    "unit": "unit"
  }
]