Public API - Refresh Token

This document will walk you through generating an API Refresh token which you can use to call the Squadcast Public API.

The Squadcast Public API provides you with the ability to access certain Squadcast features within your account, allowing you to configure users, services, grouping incidents and more to help further reduce noise and speed up response times.

Note:

We have recently changed the flow of generating a refresh token to access the Squadcast API.

In order to use the Squadcast API, you will need to first generate a Refresh token from the Squadcast Web App by following the steps below.

From Your Profile Page

  1. Move over to the My Profile page from the top right corner of your screen.

  2. In the next window, click on the Generate New Token button from the API Refresh Token section.

  3. A Refresh token will be generated and displayed. You can use this to generate the Refresh Token and use it to access our public APIs as given in the Squadcast API documentation.

Generated API Refresh Token
Image. Generated API Refresh Token

You can also Revoke the Refresh token and the associated Access Tokens will also get revoked.

Please keep your Refresh Token as safe as your Password.

For more details regarding how to use the Squadcast Public APIs, please refer to the Squadcast API Documentation.

Account Owner Controls

As an Account Owner of a Squadcast organization, you can invoke or revoke refresh tokens for admins and users in your organization.

  1. Move over to Settings from the left-side navigation panel.

Note: The API Refresh token is role restricted, that is, an API Refresh token created for a User will only allow User specific controls. The API Refresh token was created for an Admin will only provide Admin-specific controls.

2. Click on API Tokens to view the active API tokens and to create or revoke existing tokens.

Click on Assign Token To User to invoke an API Token for any User or Admin in your organization.

Invoke API Token for any user or admin in Squadcast
Image. Invoke an API Token for any user or admin

3. Pick the User or Admin from the dropdown menu for whom you want to assign an API Token. You can add more by simply clicking on the Assign Token To User and following the same process.

Selecting the user to assign an API Token
Image. Selecting the user to assign an API Token

The assigned token will also be visible to the Users/ Admins on their respective My Profile pages.

Image. User API Token visible on the Profile page

Please keep your Refresh Token as safe as your Password

Check out the list of available APIs in Squadcast API Documentation.

Last updated

#377: Key Based Deduplication

Change request updated