Get the custom fields for an environment

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId

string

required

ID of the environment

Required string length: 36

Response

200 - application/json

id

string

required

Required string length: 36

key

string

required

Maximum length: 255

name

string

required

Maximum length: 255

enabled

boolean

required

A flag indicating whether the custom field is active.

required

boolean

required

A flag indicating whether the custom field is required.

fieldType

enum<string>

required

Available options:

text,

checkbox,

select

validationRules

object

Optional validation rules for the custom field

Show child attributes

validationRules.unique

boolean

If this field must be unique for every user in the environment

validationRules.regex

string

The regex pattern that the text field must match

Maximum length: 255

validationRules.validOptions

object[]

The dropdown options for the select field

Show child attributes

validationRules.validOptions.label

string

required

Maximum length: 255

validationRules.validOptions.key

string

Maximum length: 255

validationRules.checkboxText

string

The text that will be displayed for the checkbox field

Maximum length: 255

position

number

required