Summary

You need a key before you can use the Gingr API. Every API request needs a key that is tied to a user account. You can use your own user account's key or create a new user account just for API access.

Before You Begin

• Requests use HTTP over TLS (HTTPS) and return a JSON object. All endpoints are read-only.

Important: Never share your API keys with anyone who should not access your Gingr data. If you use an employee's API key and they leave the company, or if you think a key was exposed, delete the key and create a new one for the user account.

Steps

1. Go to Left-hand Navigation: Reports & More » Users » Edit User » API Keys.

   

2. Make sure the user account that makes API requests has the Can Access API permission. Find it at Left-hand Navigation: Reports and More Icon » Groups.

   

3. Include the user's API key in each API request.

Reference: Example requests show the key as the parameter "{my_key}".

Related Articles

• API Topic Outline
• Get Started with API Topic Outline
• Gingr API Functions Reference