Skip to content
Docs
Open Soosh
How-to guideIntegrations

Create an API key

Give your own code access to Soosh, with only the permissions it needs.

2 minutesDevelopersUpdated

Before you start

Section titled “Before you start”
  • Owner or admin role in Soosh

Create the key

Section titled “Create the key”
  1. Go to Settings > API keys and click Create API key.
  2. In Name, enter where it will be used, like Order system.
  3. Optional: in Expires, choose when it stops working.
  4. Under Key scopes, open each area and tick what the key may do. Tick only what your code needs; a key with nothing ticked can do nothing.
  5. Click Create.
  6. Click the copy button next to Your API key, keep the key safe, and click Done.
Open in Soosh

Result

Section titled “Result”

The key starts with soosh_. Send it in the X-API-Key header with every request to https://app.soosh.io/api/. The list shows when each key was last used; turn a key off with its switch, or delete it.

A key can only do what you can do: if your role changes, the key’s access changes too.

Section titled “Related”