Leveraging Guru's API

Check out Guru's Developer Network for comprehensive API documentation.

Obtaining a User token

User token: the results of your requests will be based on the level of authorization associated with the user whose token you're using.

  • User tokens have read and write permissions. The user token is an extension of the permissions within your web app. The only endpoint that's different than the web app permissions is the Analytics API. In the web app, the Knowledge tab within the Analytics section can be viewed by users who have author access to that content. For our API Analytics, because there is event activity for all users, you must be an Admin to get access to that endpoint.
  1. Navigate to the Apps & Integrations page under the Manage menu.
  2. Click on the API Access tab to manage your tokens.
  3. Generate an API token for yourself by selecting Generate User Token and entering your name.
  4. You can also generate API tokens for your teammates by selecting Generate a new user token.
  5. You can reissue a token using the circular arrow icon on the right side of the dashboard next to the corresponding user. You can also revoke a user's token using the trash can icon.

To authenticate: your Username is your Guru username and your Password is the issued API token. You should not use your web app password as the authentication "password". Feel free to test your authentication on our Developer Site

Obtaining a Collection token

Collection token: results of GET requests will only return results from the Collection associated with your token.

  • Collection tokens only have read permissions as they're specific to a single Collection within your Guru instance.

You can also generate Collection-based read-only tokens by selecting Generate a New Collection Token and then selecting your desired Collection from the dropdown.CK - Generate Collection Token.png

To Authenticate: your Username is the Collection ID and your Password is the Collection token. Obtaining the Collection ID can be done by using a User token to get all Collections on your team.

Frequently Asked Questions about Guru's API

I am getting a 401 error. What does this mean?

A 401 error indicates that you have not been authenticated to perform that call. Check your credentials are correct (refresh and create a new token if needed). Additionally, you should ensure that you are properly permissioned to perform the request you are trying to make.

Why do I not see more than 50 results when making an API Call?

You'll need to page your results following these instructions in order to see more than 50 results.

Do API tokens expire?

API tokens do not expire. Any Admin can delete a token and issue a new one at any time.