API Reference

Skuid’s Javascript API can be used for a variety things, such as creating snippets, debugging Skuid pages, and building powerful, custom Skuid 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.


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

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


// Or by setting a reference

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


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!


The API calls listed on this website are considered part of Skuid’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.”