Skip to main content
GET
/
variables
Get paginated variables
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>",
      "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>"
        }
      ]
    }
  ]
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the variables in. If not provided, the default language for the organisation will be used.

Query Parameters

​
limit
integer
default:10
Required range: 1 <= x <= 100
​
skip
integer
default:0
Required range: x >= 0
​
sort
string
​
search
string
​
communityId
string
​
allocationId
string
​
featured
boolean
​
verified
boolean
​
isShop
boolean
​
type
string
​
status
string
​
eventCategory
string
​
eventSubCategory
string
​
eventName
string
​
displayMode
string
​
fromDate
string
​
toDate
string
​
isGlobalTemplate
boolean
​
key
string
​
progressPeriod
string
​
expand
string
​
redeemableType
string

Response

Successful response

​
totalCount
number
required
​
edges
Variable · object[]
required