Application Settings - Get Variable

Get Variable

Returns the value of an existing variable
Parameter NameDefault ValueRequiredDescription
application_idNULLTrueThe ID of the Application
secret_keyNULLTrueThe Application's Secret Key
access_tokenNULLFalseThe Access Token for the authenticated user
nameNULLTrueThe name of the variable
include_metafalseFalseif set to True or 1 then the return results will include the meta data of the variable including it's value

Example Success Response

{
  "success": true,
  "response_code": 200,
  "results": "bar"
}

Example Success Response with Metadata

If you have include_meta set to true, then the return results will include more information about the variable include it's value
{
  "success": true,
  "response_code": 200,
  "results": {
    "type": "string",
    "value": "bar",
    "created_timestamp": 1608239469,
    "last_updated_timestamp": 1608239469,
    "size": 22
  }
}

Metadata Results Structure

NameTypeDescription
typestringThe type of the variable
valuemixedThe value of the variable, the type for this can differ depending on the variable type
created_timestampintegerThe Unix Timestamp for when this variable was created
last_updated_timestampintegerThe Unix Timestamp for when this variable was last updated
sizeintegerThe size that this variable takes up (including it's metadata) in bytes