Skip to content
Admin API reference
/
/User Schema

Retrieve a user schema

Request

Retrieves a user Schema.

Security
ZephrHmacHttp
cURL
curl -i -X GET \
  https://demo.api.zephr.com/v3/schema/users \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK

Headers
any
Bodyapplication/json
Array [
slugstring
Example:"slug1"
visibilitystring
Value:"PUBLIC"
Example:"PUBLIC"
contextstring
Example:"slug1"
labelstring
Example:"Test"
internal-descriptionstring
Example:"This is for testing"
public-descriptionstring
Example:"Please provide some info"
requiredboolean
validation-expressionstring
Example:"test"
input-typestring
Enum:"text""color""number""range""time""datetime""date""week""month""email"
Example:"text"
select-optionsstring
Example:"null"
range-startnumber
range-endnumber
Example:100
range-stepnumber
Example:5
decision-pointboolean
publicly-writableboolean
form-useboolean
unitstring
Example:"unit"
unit-positionstring
Enum:"leading""trailing"
value-precisionnumber
stat-directionstring
Enum:"ascending""descending"
]
Response
[
  {
    "slug": "slug1",
    "label": "Test",
    "internal-description": "This is for testing",
    "public-description": "Please provide some info",
    "required": false,
    "decision-point": false,
    "validation-expression": "test",
    "input-type": "text",
    "select-options": "null",
    "range-start": 0,
    "range-end": 100,
    "range-step": 5
  }
]