Skip to main content
GET
/
variables
Get paginated 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>",
      "placeholder": "<string>",
      "useDefaultProfileValue": true,
      "availableInQuestionBank": true,
      "maxValueOccurrences": 2,
      "isSingleOutputPerUser": true,
      "isImmutable": true,
      "prerequisiteVariableConfigIds": [
        "<string>"
      ],
      "options": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "validationRegex": "<string>",
      "validationEndpointConfig": {
        "url": "<string>",
        "method": "<string>",
        "headers": {}
      },
      "createdAt": "<string>",
      "createdBy": "<string>",
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0
forQuestionBank
boolean

Response

Successful response

totalCount
number
required
edges
Variable Config · object[]
required
I