POST /public/v1/workspaces/{workspace_id}/api-keys
Generate a new API key for the workspace. Check out API Key Authentication article for detailed API Keys description.
📘
- Only an Org Admin can generate an API keys.
- To make another user a key's owner, pass
user_idof this user. The user should has an Admin role in the workspace.- Generating a new key invalidates existing key with the same type. Using this request, you can deactivate the key you're using for the request.
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace_id |
String | Yes |
Workspace id. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
type |
String | Yes |
A type of API key. Valid values:
Default value: "sandbox" |
user_id |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.