The Goal: Understand what the GrowthZone APIs offer and how to get the access and credentials you need to begin integrating your GrowthZone data with other systems.
Before You Begin:
- You will need to subscribe to the API module and have API access enabled in your tenant.
- You will need an API Client ID and Secret. For authentication, GrowthZone currently supports standard oAuth2 flows and SAML.
- Staff-level access to manage API credentials in your tenant.
Step-by-Step Instructions
Using the GrowthZone APIs makes it easy to integrate your GrowthZone data into other systems. Examples may include incorporating content such as directories and events into a CMS, creating an SSO for your website or another application, or tying a mobile app to your GrowthZone database. The API is a standard REST-based interface that provides access to many areas of the software.
- Click Here to view a full list of available GrowthZone APIs. GrowthZone's APIs are under active development, and changes or additions can occur. This documentation is updated regularly and always represents the current state. APIs in GrowthZone are broadly organized by areas of use (i.e. modules).
- Confirm you are subscribed to the API module and that API access is enabled in your tenant. If you have questions about how to subscribe to the API module, please contact the Account Management team.
- To manage your API credentials, go to Settings, Advanced Settings section, click API Key Permissions. This is where you obtain and manage your API Client ID and Secret.
- If you have questions or need help regarding API authentication, integration or support, please email platformintegrations@growthzone.com.
| NOTE: In order to begin making calls to GrowthZone, you will need to subscribe to the API module, have API access enabled in your tenant, and obtain an API Client ID and Secret. For authentication options, we currently support standard oAuth2 flows and SAML. |
Common Pitfalls
- Attempting API calls without a subscription or enabled access: Calls to GrowthZone will fail unless you are subscribed to the API module, have API access enabled in your tenant, and have obtained a valid API Client ID and Secret.