cURL
curl --request GET \ --url https://{subdomain}.nudj.cx/api/v2/integration/variables \ --header 'x-api-token: <api-key>'
{ "totalCount": 123, "edges": [ { "id": "<string>", "organisationId": "<string>", "type": "form-short-text", "name": "<string>", "label": "<string>", "maxValueOccurrences": 2, "isSingleOutputPerUser": true, "isImmutable": true, "useDefaultProfileValue": true, "placeholder": "<string>", "value": "<string>", "valueCaptureDate": "<string>", "valueValidationDate": "<string>", "prerequisiteVariableConfigIds": [ "<string>" ], "options": [ { "key": "<string>", "value": "<string>" } ] } ] }
Retrieve a paginated list of variables.
Supported query parameters:
The language to return the variables in. If not provided, the default language for the organisation will be used.
1 <= x <= 100
x >= 0
Successful response
Show child attributes
The id of the variable
The organisation that the variable 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
The maximum number of times a unique value can be used across all instances of this variable
x >= 1
Whether a user can only have one value for this variable
Whether the value, once set by a user, cannot be changed
Whether to use the default profile value
The placeholder text for the variable
The value of the variable. For select variables, this refers to the key of the selected option
The date when the value was captured
The date when the value was validated
The variable configs that must be completed before this one
The possible options for this variable
Was this page helpful?