The ScalePad API enables secure interaction with your organization's ScalePad data from third-party tools or systems. By creating an API key, you can facilitate integrations or automate tasks without using the web interface.
This article explains how to generate and manage API keys in the ScalePad Hub.
|
Who can use this feature?
|
|
Note: If the admin who created an API key leaves your organization, we recommend that another admin generate a new key. |
Generating an API key
- Sign in to the ScalePad Hub at app.scalepad.com.
- From the top navigation bar, click API (BETA).
- Select + New API key in the top-right corner.
- In the pop-up form, enter a name for the API key.
- Choose an expiration option:
- Maximum - Sets the expiry date two years from the creation date.
- Choose a date - Specify a custom expiration date.
- Click + Generate.
- Copy the secret key and store it securely. You won't be able to access it again.
- Click Done to close the pop-up window.
The new API key will appear on the API keys page with its status, creation date, expiration date, and a Delete button.
Deleting an API key
To permanently remove an API key and prevent it from working:
- Locate the API key on the API keys page.
- Click the Delete icon in the Actions column.
- Confirm the deletion.
|
Note: Any workflows using this key will stop working immediately after it's deleted. To get those workflows running again, generate a new API key and update it wherever the old one was used. |
Accessing API documentation
To view the ScalePad API documentation, click Developer portal in the upper right of the screen or navigate directly to developer.scalepad.com.
| Any questions? Feel free to check out our Hub FAQ and/or Hub FAQ for Quoter, or reach out to our friendly, neighborhood support team by submitting a support ticket. |
Related to