Skip to main content
API keys let applications read and write inventory data on behalf of your workspace — useful for ERP connectors, custom dashboards, automated imports, and internal scripts. Manage keys under Settings → API Keys (in the Developer section).
REST API access is available on Business plans and above. Free and Pro workspaces may see upgrade prompts when creating keys or calling the API.

​
Create an API key

  1. Go to Settings → API Keys.
  2. Click Create API key.
  3. Give the key a name you will recognize later (e.g. “NetSuite sync”).
  4. Choose the permission scope:
    • Full access — read and write all supported resources
    • Restricted — limit to specific capabilities (when offered in the UI)
  5. Copy the key immediately — it is shown only once.
Store keys in a secrets manager or environment variables. Never commit them to source control or share them in chat.

​
Use an API key

Include the key in the Authorization header of requests to the Retrac API: 
Authorization: Bearer YOUR_API_KEY
Also pass your workspace ID for operations that require it. Find the workspace ID under Settings → General. Full reference: API introduction, Authentication, and Security.

​
Rotate or revoke keys

Delete a key from the API Keys page when:
  • An employee with access leaves
  • A key may have leaked
  • You are decommissioning an integration
Create a new key before deleting the old one if the integration is still in production to avoid downtime.

​
Rate limits

API usage is subject to per-plan rate limits. See Rate limits and monitor for 429 responses in your integration.

​
What you can automate

Common API workflows:
  • Sync items from an external product master
  • Read on-hand balances for a fulfillment system
  • Create tags or items from a nightly job
  • Pull item counts for reporting
Start with Create item and List items. For inventory operations, see List balances, Set on-hand stock, Create transfer, and List movements.

​
Build an integration

If you ship a product that connects to Retrac, see Integrations for how to get listed.