Integrating with the GRIN API
You can integrate with GRIN's API to further customize solutions for your influencer and creator marketing campaigns. With our API, you can access data and information about your GRIN account directly, and then utilize that data in other applications or products in your workflow to streamline your processes and maximize your goals for creator marketing.
This article covers how to enable the API, where to find and access your API key (also called your API token or access token), how request limits work, and how to increase your API capacity or rate limits.
The GRIN API has two versions. When you integrate, you automatically get access to both. They are:
GRIN API v1: This API only sends data one way, from your account to you. With v1, you can leverage our API to perform actions such as:
Export a list of your GRIN creators.
Track orders made in GRIN.
Export content posted by your creators.
Export payments made in GRIN for your records.
GRIN API v2: This API sends data both ways, from your GRIN account to you and from you to your GRIN account. This means that you can not only export data in your GRIN account to use but can also send data you have about your campaigns directly into GRIN using automated workflows and API calls. With v2, you can perform actions such as:
Export a list of your code and link conversions from GRIN.
Import tracked conversions from another application into GRIN.
Directly modify existing conversions in GRIN.
The two APIs share the same API key generated in your GRIN account. However, they do not share request limits, meaning you can reach your limit for one version without affecting your limit for the other. For example, you can make 100 free requests to both the v1 and v2 APIs for a total of 200 requests overall.
Note: We highly recommend an experienced developer on your team who uses the API and references our API documentation. The API is for advanced users who want to build their own custom solutions with GRIN. We will not be able to provide dedicated support to build these solutions for you.
How to Enable the API and Generate Your API Key
If you have not integrated with the API yet, follow these steps to enable it and generate your API key:
Navigate to your Account > App Marketplace.
On the GRIN API Integration, select Generate Token.
Select Generate Token in the modal that appears. This will redirect you to your Integration Settings for the GRIN API, where you can access your API key.
Warning: Your API key is unique to your account. Do not share your key or store it in publicly accessible areas.
Where to Find Your API Key
Already generated your token and just need to locate your key again? Your API key lives in the same place you generated it:
Navigate to your Account > App Marketplace.
Select the GRIN API Integration to open its Integration Settings.
Your API key is shown in the Integration Settings. Copy it from there to use in your integration or application.
The v1 and v2 APIs use the same API key, so you only need one key for both versions.
Request Limits and Increasing Your API Capacity
Each API version has its own separate request limit (also called your rate limit or API capacity). Reaching the limit on one version does not affect the other.
If you need a higher request limit or want to increase your API capacity, please reach out to GRIN Support. Support will connect you with your account manager, who can review and adjust your API capacity for your account.
Tip: Common questions this covers: "Where do I find my API key?", "How do I get my GRIN API token?", "How do I enable the API?", "How do I increase my API request limit / rate limit / capacity?" and "How do I connect GRIN to another tool using the API?"
That's it! Once your account is integrated, you can access your API key anytime from Account > App Marketplace and contact Support if you need to raise your request limits.