Skip to Content
DevelopersAPI Keys

API Keys

Create and manage API keys to integrate your systems with Rebased.

Creating an API Key

  1. Go to Settings → Integrations in your Rebased account
  2. Click Create API Key
  3. Enter a name and optional description
  4. Select the scopes your integration needs
  5. Optionally set an expiry date
  6. Click Create

Your API key secret will be displayed once. Copy it immediately and store it securely.

Key Properties

PropertyDescription
NameA friendly name to identify the key
DescriptionOptional notes about what the key is used for
ScopesWhich API endpoints the key can access
ExpiryOptional expiration date
StatusActive, Revoked, or Expired
Last UsedWhen the key was last used
Request CountNumber of requests this billing period

Managing Keys

Viewing Keys

Go to Settings → Integrations to see all your API keys. You can see:

  • Key name and description
  • Scopes assigned
  • Last used timestamp
  • Request count this period
  • Status (Active/Revoked/Expired)

Revoking a Key

If a key is compromised or no longer needed:

  1. Find the key in Settings → Integrations
  2. Click the Revoke button
  3. Confirm the action

Revoked keys cannot be restored. Create a new key if needed.

Rotating a Key

To rotate a key (generate a new secret while keeping the same settings):

  1. Find the key in Settings → Integrations
  2. Click Rotate
  3. Copy the new secret immediately
  4. Update your integration with the new key

The old key is immediately invalidated.

Best Practices

  • Create separate keys for each integration or environment
  • Use descriptive names like “Inventory Sync - Production”
  • Set expiry dates for temporary integrations
  • Review unused keys periodically and revoke them
  • Monitor usage in the usage dashboard

Who Can Manage Keys

API keys can be created and managed by:

  • Business Admins — Full access to all integrations
  • Advisors — Can manage integrations for client businesses they have access to

Team members with other roles cannot create or view API keys.

Last updated on