Get Started with the Project API

The following information, with links to more detailed pages, will get you started developing your own project management apps.

The Project API is available to Silver, Gold, and Platinum partners only and is not available to Builder tier partners. 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 QuickBooks Online apps using GraphQL, including best practices and an FAQ, see Develop with GraphQL.

How to get access

The Projects API is a premium API available to Silver, Gold, and Platinum partners.

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 project-management.project 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 QuickBooks Online Project API:

Project endpoints

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

Required headers