Retrieve a schema slug

Admin API reference

v4 API

Request

Retrieves a schema slug.

Security

ZephrHmacHttp

Path

slugstringrequired

Unique identifier

cURL

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

Responses

Headers

any

Bodyapplication/json

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",
  "visibility": "PUBLIC",
  "context": "slug1",
  "label": "Test",
  "internal-description": "This is for testing",
  "public-description": "Please provide some info",
  "required": true,
  "validation-expression": "test",
  "input-type": "text",
  "select-options": "null",
  "range-start": 0,
  "range-end": 100,
  "range-step": 5,
  "decision-point": true,
  "publicly-writable": true,
  "form-use": true,
  "unit": "unit",
  "unit-position": "leading",
  "value-precision": 0,
  "stat-direction": "ascending"
}