Authentication reference
Authentication schemes, scopes, and operation requirements.
3 min Updated 2026-10-17Docs version 1.0 Sources: release-reference://price-compare/8542ee46#authentication
- 1Authentication schemes, scopes, and operation requirements.
In this guide
- 1Authentication schemes, scopes, and operation requirements.
Authentication reference
| Kind | Name | Requirement | Details |
|---|
| scheme | bearerAuth | bearer | Server-side API key with explicit catalog, comparison, and watchlist scopes. Never expose the key in browser code. |
| scope | sources:write | — | — |
| scope | merchant:write | — | — |
| scope | intelligence:read | — | — |
| scope | catalog:read | — | — |
| scope | compare:read | — | — |
| scope | watchlists:write | — | — |
| scope | alerts:write | — | — |
| scope | webhooks:write | — | — |
| operation | connected.catalog | catalog:read | /connected-catalog |
| operation | connected.product | catalog:read | /connected-catalog/:productId |
| operation | connected.history | catalog:read | /connected-catalog/:productId/history |
| operation | merchant.catalog.import | merchant:write | /merchant/catalog |
| operation | merchant.coverage | intelligence:read | /merchant/coverage |
| operation | products.resolve | catalog:read | /products/resolve |
| operation | offers.batch | catalog:read | /offers/batch |
| operation | watchlists.batch | watchlists:write | /watchlists/batch |
| operation | webhooks.metrics | webhooks:write | /webhook-metrics |
| operation | webhooks.audit | webhooks:write | /webhook-audit |
| operation | webhooks.test | webhooks:write | /webhooks/:webhookId/test |
| operation | webhooks.retry | webhooks:write | /webhook-deliveries/:deliveryId/retry |
| operation | webhooks.list | webhooks:write | /webhooks |
| operation | webhooks.create | webhooks:write | /webhooks |
| operation | webhooks.update | webhooks:write | /webhooks/:webhookId |
| operation | webhooks.delete | webhooks:write | /webhooks/:webhookId |
| operation | webhooks.rotation.prepare | webhooks:write | /webhooks/:webhookId/secret-rotation |
| operation | webhooks.rotation.activate | webhooks:write | /webhooks/:webhookId/secret-rotation/activate |
| operation | webhooks.rotation.cancel | webhooks:write | /webhooks/:webhookId/secret-rotation/cancel |
| operation | webhooks.incident.acknowledge | webhooks:write | /webhooks/:webhookId/incidents/acknowledge |
| operation | webhooks.deliveries | webhooks:write | /webhook-deliveries |
| operation | sources.snapshot | sources:write | /sources/:source_id/snapshot |
| operation | pricing.recommendations | intelligence:read | /pricing/recommendations |
| operation | assortment.opportunities | intelligence:read | /assortment/opportunities |
| operation | sourcing.options | intelligence:read | /sourcing/options |
| operation | campaigns.signals | intelligence:read | /campaigns/signals |
| operation | catalog.search | catalog:read | /search |
| operation | comparisons.create | compare:read | /compare |
| operation | products.read | catalog:read | /products/:canonicalProductId |
| operation | products.history | catalog:read | /products/:canonicalProductId/history |
| operation | watchlists.list | catalog:read | /watchlists |
| operation | watchlists.create | watchlists:write | /watchlists |
| operation | watchlists.update | watchlists:write | /watchlists/:watchId |
| operation | watchlists.delete | watchlists:write | /watchlists/:watchId |