This endpoint allows you to list, create, and update active globals on your account.
Listing Globals
A GET returns the globals for your organization, most recently modified first.
- key - the key of the global.
- name - the name of the global.
- value - the value of the global.
- modified_on - when this global was modified.
Example:
GET /api/v2/globals.json
Response:
{
"next": null,
"previous": null,
"results": [
{
"key": "org_name",
"name": "Org Name",
"value": "Acme Ltd",
"modified_on": "2013-02-27T09:06:15.456"
},
...
]
}
Adding a Global
A POST can be used to create a new Global. Don't specify a key as this will be generated for you.
- name - the name of the global
- value - the value of the global
Example:
POST /api/v2/global.json
{
"name": "Org Name",
"value": "Acme Ltd"
}
You will receive a global object as a response if successful:
{
"key": "org_name",
"name": "Org Name",
"value": "Acme Ltd",
"modified_on": "2013-02-27T09:06:15.456"
}
Updating a Global
A POST can also be used to update an existing global if you specify its key in the URL.
Example:
POST /api/v2/globals.json?key=org_name
{
"value": "Acme Ltd"
}
You will receive the updated global object as a response if successful:
{
"key": "org_name",
"name": "Org Name",
"value": "Acme Ltd",
"modified_on": "2013-02-27T09:06:15.456"
}