API environment

The current project and users environment.


API return values

Once the user is authenticated, the API server will return the current working environment to the calling script. Your page code can react using these values.

Value Description
env['api'] Account values for the API key used to instance the class. Returned values are title, networkDefined, version, contactName and contactEmail.
env['account'] The current account values. Regardless of how the API is initialized, this is the account that's using the system. Returned values are id, title, typeCode, hasChildren, contactName and contactEmail.
env['user'] The current user values. Returns id, name, email, accountCreator (bool), permissions (array of permission codes), lastLogin (timestamp), created (timestamp).
env['alerts'] An expandable array of API alerts relating to the current account and user environment.