Skip to main content
Retrac’s API is in beta. Questions or feedback: [email protected].
Retrac exposes a REST API for managing workspace inventory: items, tags, locations, on-hand stock, transfers, and workspace metadata.

Authentication

API keys, scopes, and workspace ID

Security

Safe integration practices

Base URL

https://api.retrac.co
HTTPS is required. HTTP requests are not supported.

Quick example

curl -s "https://api.retrac.co/items?workspaceId=YOUR_WORKSPACE_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentication

Pass your API key as a Bearer token:
Authorization: Bearer YOUR_API_KEY
See Authentication for full-access vs restricted (retrac_) keys and scope details.

Workspace ID

Most endpoints require workspaceId as a query parameter (full-access keys only):
https://api.retrac.co/items?workspaceId=YOUR_WORKSPACE_ID
Find it under Settings → General in the dashboard.

API surface

ResourceEndpointsDescription
Items/items, /items/bulk, /items/countProduct catalog CRUD
Tags/tagsOrganize items
Locations/locations, /locations/countWarehouses, vans, sites
Inventory/inventory/balances, /inventory/movementsStock levels and ledger
Transfers/inventory/transfersMove stock between locations
Workspaces/workspacesWorkspace metadata
OpenAPI spec: https://api.retrac.co

Response codes

CodeMeaning
200Success
201Created
400Bad request
401Invalid or missing API key
403Forbidden (scope, role, or plan)
404Resource not found
409Conflict (duplicate slug, name, etc.)
429Rate limit exceeded
500Server error
See Errors for machine-readable error codes.

Versioning

The API is currently at version 0.0.1. Breaking changes will be minimized during beta; monitor this documentation for updates.