Create an API key

Create an expiring organization API key for a trusted service that calls the Orvelt Business API.

A Business guide, updated October 16, 2026. Writing opinions as a customer? See Storefront guides

An API key lets one of your services call the Orvelt Business API without a person signing in. Each key works for every project in your organization, expires after the period you choose, and is shown in full only once.

Create the key

You need the API keys product access, or an owner or admin role.

Name the key and choose an expiry

  1. Open Manage Settings > API Keys.
  2. Select Create key.
  3. Enter a Key name that says which service uses it, such as Order sync.
  4. Under Expires, choose 30 days, 90 days, or 1 year.
  5. Select Create key.
The API Keys page lists each key's name, prefix, created date, last-used date, expiry date, and an actions menu.
Screenshot description: The API Keys page lists each key's name, prefix, created date, last-used date, expiry date, and an actions menu.

Copy and store the key

Orvelt shows the full key once, right after you create it.

Save it before you close the dialog

Select Copy, then paste the key into your service's secret manager. Do not put it in source code, screenshots, tickets, or chat messages. After you select Done, only the key's first characters remain visible.

The API key created dialog says the key cannot be viewed again and provides Copy and Done buttons; the key is redacted in this guide.
Screenshot description: The API key created dialog says the key cannot be viewed again and provides Copy and Done buttons; the key is redacted in this guide.

What the key can do

Every key includes the same access:

  • Read opinions, answers, and subscribers.
  • Invite subscribers and manage questions.
  • Create, email, resend, and list preverified customer links.
  • Display rotating QR codes.

A key cannot reply to opinions, change goals, remove subscribers, create or revoke QR codes, or manage members, billing, API keys, knowledge, or webhooks. Do those in Orvelt Business.

Rename, replace, or delete a key

Use the ... menu at the end of a key's row.

If the key is lost or exposed

Select Delete to stop the key working immediately, create a replacement, and update your service with the new key. Rename changes only the display name; the key itself stays the same.

Before a key expires, create its replacement and switch your service over, then delete the old key.