Application Settings - Get Variable
Get Variable
Returns the value of an existing variableParameter Name | Default Value | Required | Description |
application_id | NULL | True | The ID of the Application |
secret_key | NULL | True | The Application's Secret Key |
access_token | NULL | False | The Access Token for the authenticated user |
name | NULL | True | The name of the variable |
include_meta | false | False | if 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 haveinclude_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
Name | Type | Description |
type | string | The type of the variable |
value | mixed | The value of the variable, the type for this can differ depending on the variable type |
created_timestamp | integer | The Unix Timestamp for when this variable was created |
last_updated_timestamp | integer | The Unix Timestamp for when this variable was last updated |
size | integer | The size that this variable takes up (including it's metadata) in bytes |