curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/variables \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"type": "form-short-text",
"name": "<string>",
"label": "<string>",
"useDefaultProfileValue": true,
"availableInQuestionBank": true,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": true,
"isImmutable": true,
"createdAt": "<string>",
"createdBy": "<string>",
"placeholder": "<string>",
"prerequisiteVariableConfigIds": [
"<string>"
],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>",
"validationEndpointConfig": {
"url": "<string>",
"method": "<string>",
"headers": {}
},
"updatedAt": "<string>",
"updatedBy": "<string>"
}
]
}Retrieve a paginated list of variable configs.
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/admin/variables \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"type": "form-short-text",
"name": "<string>",
"label": "<string>",
"useDefaultProfileValue": true,
"availableInQuestionBank": true,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": true,
"isImmutable": true,
"createdAt": "<string>",
"createdBy": "<string>",
"placeholder": "<string>",
"prerequisiteVariableConfigIds": [
"<string>"
],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>",
"validationEndpointConfig": {
"url": "<string>",
"method": "<string>",
"headers": {}
},
"updatedAt": "<string>",
"updatedBy": "<string>"
}
]
}1 <= x <= 100x >= 0Successful response
Show child attributes
The id of the variable config
The organisation that the variable config belongs to
Determines how the variable should be rendered in the UI (e.g., text input, select dropdown, date picker, etc.)
form-short-text, form-long-text, form-number, form-select, form-checkbox, form-email, form-name, form-address, form-date The name of the variable
The label of the variable
Whether to use the default profile value
Whether this variable is available in the question bank
The maximum number of times a unique value can be used across all instances of this variable
x >= 1Whether a user can only have one output for this variable
Whether the value, once set by a user, cannot be changed
The date when this variable config was created
The user who created this variable config
The placeholder text
The variable configs that must be completed before this one
Regular expression pattern to validate variable values. If set, values must match this pattern.
The date when this variable config was last updated
The user who last updated this variable config
Was this page helpful?