Skip to main content

ProsperStack API

Prosper planEnterprise plan

ProsperStack provides a REST-based API for access to your data to build custom integrations.

Reference documentation​

Refer to the API reference documentation for complete documentation on using the API.

Creating an API key​

Click the gear icon in the main header to open Settings, then select API keys. Click Create API key to create a new API key.

Creating an API key

Enter a name for the API key and click Submit. The name is required and must be unique among your existing API keys. Your new API key will be shown.

New API key

When creating a live mode key, make sure to save the key somewhere safe since it will not be displayed again! Live mode API keys begin with the prefix key_.

Test mode API keys​

Creating an API key in test mode will create a special test mode API key that is scoped to your test account. A test mode key begins with the prefix key_test_.

Test mode keys can be viewed at any time after creation for convenience when developing your integration.

Revoking an API key​

Revoking a key prevents it from being used for API access. Before revoking a key that is in use, create a replacement and update the impacted integrations.

On the API keys page, find the key and click Revoke, then click Revoke again to confirm. The revoked key can no longer be used.