> ## Documentation Index
> Fetch the complete documentation index at: https://docs.antsfield.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API keys

> Create API keys to connect Retrac with your tools, scripts, and integrations.

**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).

<Note>
  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.
</Note>

## 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](/api-reference/introduction), [Authentication](/api-reference/authentication), and [Security](/api-reference/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](/api-reference/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](/api-reference/endpoint/create-a-new-item) and [List items](/api-reference/endpoint/retrieve-a-list-of-items). For inventory operations, see [List balances](/api-reference/endpoint/list-inventory-balances), [Set on-hand stock](/api-reference/endpoint/set-on-hand-stock), [Create transfer](/api-reference/endpoint/create-a-transfer), and [List movements](/api-reference/endpoint/list-inventory-movements).

## Build an integration

If you ship a product that connects to Retrac, see [Integrations](/integrations) for how to get listed.