Note: Nintex Apps data centers are located in West US and Australia (AUS). In-region processing of Nintex Apps data is only available in these regions.

API Reference

Nintex Apps's Javascript API can be used for a variety things, such as creating snippets, debugging Nintex Apps pages, and building powerful, custom Nintex Apps components.

These API calls are arranged by namespace, with each page containing properties, functions, and code samples where appropriate. More complex, nested namespaces also have their own separate pages.

Sandboxing

As of API v2, Nintex Apps sandboxes its page APIs. This means each Nintex Apps page has its own context, with its own unique runtime and set of APIs.

If using Nintex Apps's APIs from within the console—or to access the data from another app page (such as through a Page Include or Skuid Page Lightning Component)—then you'll need to access them from their specific skuid.runtime instance:

Copy

skuid.runtime.getPage('MyPageName').model.getModelsByName()

// Or by setting a reference

var skuid1 = skuid.runtime.getPage('MyPageName')
skuid1.model.getModelsByName()

Note:

If using these APIs from an inline resource, you do not have to declare a runtime context. Any JavaScript contained within a page's inline resources or static resources will assume the context it is run from.

For example, page A—running on API v2—contains a inline snippet that uses skuid.models.getModelList()

Because it is being run from within that page, you do not need to update your code to specify a skuid.runtime context.

Have more questions about what you see here? Visit our community!

Important: The API calls listed on this website are considered part of Nintex Apps's public API and may be used freely. Conversely, any API call not listed here may be rendered nonfunctional at any time by future updates and should be considered "use at your own risk."