How To Create an API Token in Goldcast

Plan Availability Starter Pro Premium Enterprise

For customers with contracts starting March 2024 or later, feature availability is based on your pricing tier. If interested, contact your CSM or our Sales Team to discuss pricing options. 


Overview

Personal access tokens in Goldcast function like ordinary OAuth access tokens. You can use them to authenticate requests to the Goldcast API. Whenever a third-party application calls a Goldcast API endpoint, you must provide a valid API token. This article explains how to create and extract an API token in Goldcast Studio. 

Heads up! Tokens are disabled in Goldcast by default. If it's included in your plan, you'll need to contact our support team to enable this feature for your organization. 

Creating a Goldcast API token

Follow these steps to create a Goldcast API token:

  1. Login to Goldcast Studio using your credentials. 
    Note: If you have the teams feature enabled for your Goldcast organization, only organization admins can create tokens. Team admins will not be able to create or delete tokens. 
  2. Click the hamburger icon 1716974470194-b873d1a2-fe13-44aa-b2f0-07bae0cefd20 (1600×1600) on the top left and select Settings in the left sidebar.
    1716974527613-ee27f1e0-5521-4492-a7b1-4a68ece0dc76 (373×535)
  3. Select Tokens and click the Create New Token button. 
    1716974563242-1f22a26e-052f-410e-b218-1c92a3ee6255 (1118×531)
  4. Name your token and click Generate Token. The name can be anything of your choice. 
  5. The token value will be displayed only once. You’ll not be able to check it later. So, make sure to copy-paste in a safe location. 
    1716974602964-a56ac06b-fb75-4289-8c64-91cdbb7cab32 (1032×295)

Deleting the Goldcast API token

  1. Login to Goldcast Studio using your credentials. 
    Note: If you have teams enabled for your Goldcast organization, only organization admins can create and delete tokens. 
  2. Click the hamburger icon 1716974470194-b873d1a2-fe13-44aa-b2f0-07bae0cefd20 (1600×1600) on the top left and select Settings in the left sidebar.
  3. Select Tokens and scroll to find your preferred token.
  4. Click the delete icon.  
    1716974668650-6bbb0f17-937e-46d7-96a2-5f39bf399a1b (1095×91)
  5. Click the delete button on the confirmation screen to complete the action.  
    1716974699984-0ddd0cca-f079-4a97-93b9-a35de0b720e5 (817×316)

Note: Deleting a token is irreversible and will break any integrations using it. So, make sure to proceed with caution.

© 2024 Copyright Goldcast, Inc. All rights reserved.


Knowledge Base Software powered by Helpjuice