Get started with dimensions

The following information, with links to more detailed pages, will get you started creating and managing dimensions in your own apps.

The Dimensions API is available to Silver, Gold, and Platinum partners only and is not available to Builder tier partners. It is available for use with Intuit Enterprise Suite only. To upgrade your tier, visit the Intuit Developer Portal. If you’re already on a paid tier and don’t have access, open a support ticket.

Develop with GraphQL

For detailed information on how to develop using the GraphQL query language, including endpoints, authentication, required headers, and testing, see Learn about GraphQL. For information on how to develop apps using GraphQL, including best practices and an FAQ, see Develop with GraphQL.

How to get access

The Dimensions API is a premium API available to Silver, Gold, and Platinum partners for use with Intuit Enterprise Suite.

To get access:

  1. Upgrade to the Silver tier or higher on the Intuit Developer Portal.
  2. Once your tier is active, go to your app’s Permissions page in the Developer Portal. Enable the app-foundations.custom-dimensions.read scope under Restricted scopes.
  3. Add the enabled scope to your OAuth authorization requests.

If you’re already on a paid tier and still don’t have access, open a support ticket.

Authorize your app

Authorize your app as described here.

Scopes

Scopes limit what data your app can read and update. Instead of getting broad permissions for everything, set granular permissions so your app only focuses on what’s necessary. Here are the scopes for the Intuit Enterprise Suite Dimensions API:

Endpoints

To develop your app using dimensions you will use both the dimensions API, which is based on GraphQL and uses a single endpoint, and also the QuickBooks Online REST APIs.

Required headers