This is the interface for interacting with app components.

This reference is generated from our OpenAPI Specification, and contains a comprehensive reference for objects, schemas, and endpoints available in the app components API.

To view the API reference for the REST API (non-app components), click here.


Getting started

To begin building with app components, visit the getting started guide.


  • Objects are ordered alphabetically in the sidebar
  • Object schemas can be found by selecting the object in the sidebar (e.g., Widgets)
  • Select an endpoint (e.g., get widget metadata) to see parameters and successful (200) responses

UI builder

To see and test more example response shapes for app components endpoints, visit the UI builder.

Additional resources