API keys, the MCP server and the REST API
Instead of filling in forms, you can ask an AI agent you already use, such as Claude Code or Cursor, to do the work in productrue for you. It connects either by asking you to approve it in your browser, or with an API key you create. Either way, it can:
The agent acts as you: with your role, in the organisation you created the key in. It cannot do anything your role cannot do in the web app.
Sign in and open Settings → API keys. Give the key a name you will recognise later (for example Claude Code on my laptop) and choose:
The key is shown once. productrue keeps only a hash of it, so copy it straight into your agent's configuration. If you lose it, revoke it and create a new one.
If your agent supports signing in through the browser (Claude Code does), you can skip the key: see the next step.
productrue runs an MCP (Model Context Protocol) server at:
https://app.productrue.com/api/v1/mcp
It uses the Streamable HTTP transport. There are two ways to authenticate.
Clients that support MCP's OAuth sign-in only need the address. In Claude Code:
claude mcp add --transport http productrue https://app.productrue.com/api/v1/mcp
Then run /mcp inside Claude Code, pick productrue and choose to authenticate. Your browser opens productrue: sign in if you need to, choose the company and the access (read only, or read and write), and approve. The connection is listed under Settings → API keys, in Connected apps, where you can disconnect it at any time.
claude mcp add --transport http productrue https://app.productrue.com/api/v1/mcp \
--header "Authorization: Bearer YOUR_API_KEY"
{
"mcpServers": {
"productrue": {
"url": "https://app.productrue.com/api/v1/mcp",
"headers": { "Authorization": "Bearer YOUR_API_KEY" }
}
}
}
The API keys page shows both snippets with your key already filled in, right after you create it.
Claude.ai and ChatGPT connectors use the same browser sign-in. We have not tried them against productrue yet; if one will not connect, tell us.
Once connected, your agent sees these tools — only the ones your role allows and your plan includes, and with a read-only key only those that do not change data. ✎ marks the tools that change data.
get_account | Your organisation, role, permissions and active modules. A good first call. |
check_approval | Whether a person approved an action that was waiting, and its result. |
search_products | Search products by text, status or schema. |
get_product | One product with all its attribute values. |
create_product | Create one product in a schema. ✎ |
update_product | Change a product's SKU, status or some of its attributes. ✎ |
import_products | Create or update up to 1,000 products in one call, or from a CSV/XLSX link. Matches existing products by SKU. ✎ |
get_import | Progress of an import, with the errors per row. |
delete_products | Delete up to 100 products. ✎ |
list_variants | A product's variants and the attributes that define them. |
create_variant | Add one variant to a product. ✎ |
generate_variants | Create a variant for every combination of the variant attributes. ✎ |
update_variants | Change several variants of one product at once. ✎ |
delete_variant | Delete one variant. ✎ |
upload_media | Add images or PDFs to the media library from links. ✎ |
add_product_image | Fetch an image from a link and attach it to a product. ✎ |
search_media | Find media files by name, tag or folder. |
organise_media | Tag, untag, move or delete many media files at once. ✎ |
list_media_folders | The media folders and how many files each holds. |
manage_media_folder | Create, rename, move or delete a media folder. ✎ |
match_images | Propose which images belong to which products by file name and SKU. ✎ |
confirm_image_matches | Attach the proposed images to their products. ✎ |
list_product_schemas | The product schemas (product types). |
get_product_schema | One schema with its attributes: code, type, whether required, options. |
create_product_schema | Create a schema with its groups and attributes in one call. ✎ |
update_product_schema | Change a schema's name, status, display-name or base-price attribute. ✎ |
add_attribute | Add one attribute to a schema. ✎ |
update_attribute | Change one attribute: label, required, role, limits or options. ✎ |
delete_attribute | Delete an attribute and its values. ✎ |
delete_product_schema | Delete a schema no product uses. ✎ |
add_attribute_options | Add new choices to a select attribute, e.g. an author or brand. ✎ |
list_reference_lists | Shared value lists that select attributes take their options from. |
list_reference_items | The values in one reference list. |
manage_reference_list | Create, update or delete a reference list. ✎ |
manage_reference_item | Create, rename, disable, delete or reorder list values. ✎ |
list_warehouses | Warehouses and their locations. |
get_stock | Stock units by product, warehouse or location. |
receive_stock | Record goods received at a location. ✎ |
adjust_stock | Increase or decrease a stock unit, with a reason. ✎ |
transfer_stock | Move stock to another location or warehouse. ✎ |
get_product_stock | How much of one product is in stock, per warehouse and location. |
list_stock_movements | The stock ledger: receipts, adjustments, transfers, sales. |
get_inventory_summary | Stock value, units and low-stock count at a glance. |
manage_warehouse | Create, update, make default or delete a warehouse. ✎ |
manage_location | Create, update or delete a location (room, shelf, bin). ✎ |
get_location_label | A location's label text or its QR code as a download link. |
search_suppliers | Find suppliers, or one supplier with its recent deliveries. |
manage_supplier | Create, update or delete a supplier. ✎ |
list_stock_alerts | Low-stock alerts and which are triggered now. |
set_stock_alert | Set a product's minimum stock and reorder quantity. ✎ |
manage_stock_alert | Acknowledge or delete a low-stock alert. ✎ |
lookup_barcode | What a scanned barcode is: product, stock unit or location. ✎ |
generate_barcode | Generate a new barcode, or one for a location. ✎ |
search_orders | Search orders by text, status, dealer or date. |
get_order | One order with its lines. |
update_order_status | Move an order through its workflow. ✎ |
update_order | Change an order's notes. ✎ |
get_order_fulfilment | Shipments and returns of an order. |
create_shipment | Ship some or all lines of an order, with tracking. ✎ |
create_return | Record goods returned from an order. ✎ |
get_order_document | The order as a PDF, as a download link. |
get_order_summary | Order totals for a period and how many wait for action. |
list_catalogues | Your catalogues. |
add_products_to_catalogue | Add up to 100 products to a catalogue. ✎ |
get_catalogue | One catalogue with its products, settings and dealers. |
manage_catalogue | Create, update or delete a catalogue and its settings. ✎ |
manage_catalogue_products | Remove products from a catalogue or reorder them. ✎ |
share_catalogue | Share with dealers, renew the link or set a password. ✎ |
search_dealers | Find dealers, or one dealer with its catalogues and users. |
manage_dealer | Create, update or delete a dealer. ✎ |
manage_dealer_user | Create, update or delete a dealer's staff login. ✎ |
dealer_prices | Read or set a dealer's own prices in a catalogue. ✎ |
list_price_lists | Price lists, or one list with its prices. |
manage_price_list | Create, update, activate, archive or delete a price list. ✎ |
set_prices | Set exact prices for up to 100 products. ✎ |
bulk_update_prices | Change many prices by a rule, e.g. +5% rounded to .99. ✎ |
export_prices | A price list as CSV, as a download link. |
resolve_prices | The final price a dealer would pay, after discounts. ✎ |
list_channels | Sales channels, or one channel with its products. |
manage_channel | Create, update or delete a sales channel. ✎ |
manage_channel_products | Add products to a channel or take them off. ✎ |
get_channel_listing | How a product will appear on one channel. |
set_channel_override | Channel-only title, description, price, images or attribute values. ✎ |
run_channel_export | Start or cancel a product export for a channel. ✎ |
get_channel_exports | Export jobs, their progress and the finished file. |
list_export_templates | Export templates, or one with its columns. |
manage_export_template | Create, update or delete an export template. ✎ |
get_marketplace_mapping | How a schema's fields map to a marketplace. |
save_marketplace_mapping | Save, check, activate or roll back a marketplace mapping. ✎ |
list_integrations | Connected stores and marketplaces, and what each can do. |
manage_integration | Sync listings, orders or stock; check a product; disconnect. ✎ |
search_integration_logs | What the connections did, with failures and counts. |
search_leads | Find CRM leads, or one lead with its history. |
manage_lead | Create, update, move, convert or delete a lead. ✎ |
log_lead_activity | Record a note, call, email, meeting or task on a lead. ✎ |
list_pipelines | Sales pipelines, their stages and the lead board. |
manage_pipeline | Create, update, reorder or delete a pipeline. ✎ |
list_lead_forms | Lead-capture forms and their submissions. |
manage_lead_form | Create, update or delete a lead-capture form. ✎ |
search_invoices | Sales invoices, one invoice, or totals for a period. |
manage_invoice | Create an invoice or one from an order; issue, mark paid, void. ✎ |
search_expenses | Recorded expenses, one expense, or totals. |
manage_expense | Record, update or delete an expense. ✎ |
get_accounting_report | Revenue, expenses and profit and loss for a period. |
get_dashboard | The home screen's headline numbers. |
get_audit_report | Who changed what: reports, record history, export. |
list_notifications | Your notifications and how many are unread. |
mark_notifications_read | Mark one or all notifications as read. ✎ |
list_team | People in the account, their roles and ids. |
Stock is an append-only ledger: nothing edits a quantity directly. Receipts and adjustments are recorded as movements and the balance follows, exactly as in the web app.
Scripts and automation tools such as n8n can use the same key without MCP. Every tool is a thin layer over one of these endpoints, so the rules are identical.
curl "https://app.productrue.com/api/v1/products/products?search=oak" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"
| Account | |
|---|---|
get_account | GET /auth/meGET /billing/modules/active |
check_approval | |
| Products and variants | |
search_products | GET /products/products |
get_product | GET /products/products/{product} |
create_product | POST /products/products |
update_product | PATCH /products/products/{product} |
import_products | POST /products/imports/analyzePOST /products/imports |
get_import | GET /products/imports/{import} |
delete_products | POST /products/products/bulk-delete |
list_variants | GET /products/products/{product}/variantsGET /products/products/{product}/variant-attributes |
create_variant | POST /products/products/{product}/variants |
generate_variants | POST /products/products/{product}/variants/generate |
update_variants | PUT /products/products/{product}/variants/bulk |
delete_variant | DELETE /products/products/{product}/variants/{variant} |
| Images and media | |
upload_media | POST /media/assetsPOST /media/assets/bulk/movePOST /media/assets/bulk/tag |
add_product_image | GET /products/products/{product}GET /products/schemas/{schema}POST /media/assetsPATCH /products/products/{product} |
search_media | GET /media/assetsGET /media/tags/{tagName}/assetsGET /media/folders/{folder} |
organise_media | POST /media/assets/bulk/tagDELETE /media/assets/bulk/tagPOST /media/assets/bulk/moveDELETE /media/assets/bulk |
list_media_folders | GET /media/folders |
manage_media_folder | POST /media/foldersPUT /media/folders/{folder}/renamePUT /media/folders/{folder}/moveDELETE /media/folders/{folder} |
match_images | POST /media/match |
confirm_image_matches | POST /media/match/confirm |
| Schemas and reference lists | |
list_product_schemas | GET /products/schemas |
get_product_schema | GET /products/schemas/{schema} |
create_product_schema | POST /products/schemasPOST /products/schemas/{schema}/attribute-groupsPOST /products/schemas/{schema}/attribute-groups/{attributeGroup}/attributesPUT /products/schemas/{schema}/display-namePUT /products/schemas/{schema}/base-price |
update_product_schema | PATCH /products/schemas/{schema}PUT /products/schemas/{schema}/display-namePUT /products/schemas/{schema}/base-price |
add_attribute | GET /products/schemas/{schema}POST /products/schemas/{schema}/attribute-groupsPOST /products/schemas/{schema}/attribute-groups/{attributeGroup}/attributes |
update_attribute | GET /products/schemas/{schema}PATCH /products/schemas/{schema}/attribute-groups/{attributeGroup}/attributes/{attribute} |
delete_attribute | GET /products/schemas/{schema}DELETE /products/schemas/{schema}/attribute-groups/{attributeGroup}/attributes/{attribute} |
delete_product_schema | DELETE /products/schemas/{schema} |
add_attribute_options | PATCH /products/schemas/{schema}/attribute-groups/{attributeGroup}/attributes/{attribute}POST /refdata/lists/{referenceList}/items/import |
list_reference_lists | GET /refdata/lists |
list_reference_items | GET /refdata/lists/{referenceList}/items |
manage_reference_list | POST /refdata/listsPATCH /refdata/lists/{referenceList}DELETE /refdata/lists/{referenceList} |
manage_reference_item | POST /refdata/lists/{referenceList}/itemsPATCH /refdata/lists/{referenceList}/items/{referenceItem}DELETE /refdata/lists/{referenceList}/items/{referenceItem}POST /refdata/lists/{referenceList}/items/reorder |
| Inventory | |
list_warehouses | GET /inventory/warehouses |
get_stock | GET /inventory/stock |
receive_stock | POST /inventory/stock/receive |
adjust_stock | POST /inventory/stock/{stockUnit}/adjust |
transfer_stock | POST /inventory/stock/{stockUnit}/transfer |
get_product_stock | GET /inventory/products/{productId}/stock |
list_stock_movements | GET /inventory/movements |
get_inventory_summary | GET /inventory/reports/summary |
manage_warehouse | POST /inventory/warehousesPUT /inventory/warehouses/{warehouse}POST /inventory/warehouses/{warehouse}/set-defaultDELETE /inventory/warehouses/{warehouse} |
manage_location | POST /inventory/warehouses/{warehouse}/locationsPUT /inventory/locations/{location}DELETE /inventory/locations/{location} |
get_location_label | GET /inventory/locations/{location}/labelGET /inventory/locations/{location}/qr-code |
search_suppliers | GET /inventory/suppliersGET /inventory/suppliers/{supplier}GET /inventory/suppliers/{supplier}/movements |
manage_supplier | POST /inventory/suppliersPUT /inventory/suppliers/{supplier}DELETE /inventory/suppliers/{supplier} |
list_stock_alerts | GET /inventory/alertsGET /inventory/alerts/summary |
set_stock_alert | POST /inventory/products/{productId}/alert |
manage_stock_alert | POST /inventory/alerts/{stockAlert}/acknowledgeDELETE /inventory/alerts/{stockAlert} |
lookup_barcode | POST /inventory/barcode/scan |
generate_barcode | POST /inventory/barcode/generatePOST /inventory/locations/{location}/generate-barcode |
| Orders | |
search_orders | GET /orders/orders |
get_order | GET /orders/orders/{order} |
update_order_status | PUT /orders/orders/{order}/status |
update_order | PUT /orders/orders/{order} |
get_order_fulfilment | GET /orders/orders/{orderId}/shipmentsGET /orders/orders/{orderId}/returns |
create_shipment | POST /orders/orders/{orderId}/shipments |
create_return | POST /orders/orders/{orderId}/returns |
get_order_document | GET /orders/orders/{orderId}/document |
get_order_summary | GET /orders/reports/summaryGET /orders/orders/pending-count |
| Catalogues | |
list_catalogues | GET /catalogues/catalogues |
add_products_to_catalogue | POST /catalogues/catalogues/{catalogue}/products |
get_catalogue | GET /catalogues/catalogues/{catalogue}GET /catalogues/catalogues/{catalogue}/dealers |
manage_catalogue | POST /catalogues/cataloguesPATCH /catalogues/catalogues/{catalogue}PATCH /catalogues/catalogues/{catalogue}/settingsDELETE /catalogues/catalogues/{catalogue} |
manage_catalogue_products | DELETE /catalogues/catalogues/{catalogue}/products/{productId}PUT /catalogues/catalogues/{catalogue}/products/reorder |
share_catalogue | POST /catalogues/catalogues/{catalogue}/dealersDELETE /catalogues/catalogues/{catalogue}/dealers/{dealerId}POST /catalogues/catalogues/{catalogue}/share/rotate-tokenPUT /catalogues/catalogues/{catalogue}/share/password |
| Dealers | |
search_dealers | GET /dealers/dealersGET /dealers/dealers/{dealer}GET /dealers/dealers/{dealer}/users |
manage_dealer | POST /dealers/dealersPATCH /dealers/dealers/{dealer}DELETE /dealers/dealers/{dealer} |
manage_dealer_user | POST /dealers/dealers/{dealer}/usersPATCH /dealers/dealers/{dealer}/users/{dealerUser}DELETE /dealers/dealers/{dealer}/users/{dealerUser} |
dealer_prices | GET /dealers/dealers/{dealer}/catalogues/{catalogue}/pricesPUT /dealers/dealers/{dealer}/catalogues/{catalogue}/prices |
| Prices | |
list_price_lists | GET /pricing/price-listsGET /pricing/price-lists/{priceList}GET /pricing/price-lists/{priceList}/prices |
manage_price_list | POST /pricing/price-listsPUT /pricing/price-lists/{priceList}POST /pricing/price-lists/{priceList}/activatePOST /pricing/price-lists/{priceList}/archiveDELETE /pricing/price-lists/{priceList} |
set_prices | PUT /pricing/price-lists/{priceList}/prices/{productId}DELETE /pricing/price-lists/{priceList}/prices/{productId} |
bulk_update_prices | POST /pricing/price-lists/{priceList}/prices/bulk |
export_prices | GET /pricing/price-lists/{priceList}/prices/export.csv |
resolve_prices | POST /pricing/resolve-many |
| Channels and marketplaces | |
list_channels | GET /channels/channelsGET /channels/channels/{channelId}GET /channels/channels/{channelId}/productsGET /channels/products/{productId}/channels |
manage_channel | POST /channels/channelsPATCH /channels/channels/{channelId}DELETE /channels/channels/{channelId} |
manage_channel_products | POST /channels/channels/{channelId}/productsDELETE /channels/channels/{channelId}/products/{productId} |
get_channel_listing | GET /channels/products/{productId}/channels/{channelId}/contextGET /channels/channels/{channelId}/products/{productId}/override |
set_channel_override | PUT /channels/channels/{channelId}/products/{productId}/overridePUT /channels/products/{productId}/channels/{channelId}/overridesPOST /channels/products/{productId}/channels/{channelId}/recompute |
run_channel_export | POST /channels/channels/{channelId}/exportsPOST /channels/channels/{channelId}/exports/{jobId}/cancel |
get_channel_exports | GET /channels/channels/{channelId}/exportsGET /channels/channels/{channelId}/exports/{jobId}GET /channels/channels/{channelId}/exports/{jobId}/download |
list_export_templates | GET /channels/export-templatesGET /channels/export-templates/{templateId} |
manage_export_template | POST /channels/export-templatesPUT /channels/export-templates/{templateId}DELETE /channels/export-templates/{templateId} |
get_marketplace_mapping | GET /channels/marketplacesGET /channels/schemas/{schemaId}/marketplace-mappingsGET /channels/schemas/{schemaId}/marketplace-mappings/{marketplace}GET /channels/schemas/{schemaId}/marketplace-mappings/{marketplace}/historyGET /channels/schemas/{schemaId}/semantic-roles |
save_marketplace_mapping | POST /channels/schemas/{schemaId}/marketplace-mappingsPOST /channels/schemas/{schemaId}/marketplace-mappings/validatePOST /channels/schemas/{schemaId}/marketplace-mappings/{schemaMapping}/activatePOST /channels/schemas/{schemaId}/marketplace-mappings/{marketplace}/rollbackPOST /channels/marketplaces/{marketplace}/refresh-attributes |
list_integrations | GET /integrations/availableGET /integrations/connectionsGET /integrations/connections/{integrationConnection}GET /integrations/connections/{integrationConnection}/capabilitiesGET /integrations/connections/{integrationConnection}/mappingsGET /integrations/connections/{integrationConnection}/field-mappings |
manage_integration | POST /integrations/connections/{integrationConnection}/health-checkPOST /integrations/connections/{integrationConnection}/sync/listingsPOST /integrations/connections/{integrationConnection}/sync/ordersPOST /integrations/connections/{integrationConnection}/sync/inventoryPUT /integrations/connections/{integrationConnection}/field-overridesPOST /integrations/connections/{integrationConnection}/previewPOST /integrations/connections/{integrationConnection}/validate-productDELETE /integrations/connections/{integrationConnection} |
search_integration_logs | GET /integrations/logsGET /integrations/logs/{id}GET /integrations/logs/stats |
| CRM | |
search_leads | GET /crm/leadsGET /crm/leads/{lead}GET /crm/leads/{lead}/activities |
manage_lead | POST /crm/leadsPATCH /crm/leads/{lead}POST /crm/leads/{lead}/move-stagePOST /crm/leads/{lead}/convertDELETE /crm/leads/{lead} |
log_lead_activity | POST /crm/leads/{lead}/activitiesDELETE /crm/leads/{lead}/activities/{activity} |
list_pipelines | GET /crm/pipelinesGET /crm/pipelines/{pipeline}GET /crm/pipelines/{pipeline}/kanban |
manage_pipeline | POST /crm/pipelinesPATCH /crm/pipelines/{pipeline}POST /crm/pipelines/{pipeline}/stages/reorderDELETE /crm/pipelines/{pipeline} |
list_lead_forms | GET /crm/formsGET /crm/forms/{crmForm}GET /crm/forms/{crmForm}/submissions |
manage_lead_form | POST /crm/formsPATCH /crm/forms/{crmForm}DELETE /crm/forms/{crmForm} |
| Accounting | |
search_invoices | GET /accounting/invoicesGET /accounting/invoices/{invoice}GET /accounting/invoices/by-order/{orderId}GET /accounting/invoices/stats |
manage_invoice | POST /accounting/invoicesPOST /accounting/invoices/from-orderPOST /accounting/invoices/{invoice}/issuePOST /accounting/invoices/{invoice}/mark-paidPOST /accounting/invoices/{invoice}/void |
search_expenses | GET /accounting/expensesGET /accounting/expenses/{expense}GET /accounting/expenses/stats |
manage_expense | POST /accounting/expensesPUT /accounting/expenses/{expense}DELETE /accounting/expenses/{expense} |
get_accounting_report | GET /accounting/dashboardGET /accounting/reports/revenueGET /accounting/reports/expensesGET /accounting/reports/profit-loss |
| Reports and activity | |
get_dashboard | GET /dashboard/stats |
get_audit_report | GET /audit/reports/overviewGET /audit/reports/top-actionsGET /audit/reports/failed-actionsGET /audit/reports/timelineGET /audit/reports/by-eventGET /audit/reports/by-subjectGET /audit/reports/active-usersGET /audit/statsGET /audit/subject/{subjectType}/{subjectId}GET /audit/{id}GET /audit/export/json |
list_notifications | GET /platform/notificationsGET /platform/notifications/unread-count |
mark_notifications_read | POST /platform/notifications/{id}/readPOST /platform/notifications/mark-all-read |
list_team | GET /settings/team |
Paths are relative to https://app.productrue.com/api/v1. Always call that host: keys are refused on the other productrue hosts.
Every response uses the same envelope. A success is {"ok": true, "data": ...}; lists add meta with the pagination, and ?page= selects a page. A failure is {"ok": false, "error": {"code": "...", "message": "...", "details": {...}}}.
These operations are the supported, documented API. The web app calls other endpoints too and your key will reach them, but they are built for our own screens and may change without notice.
Agents retry when a call times out. A retried "receive 50 units" must not book 100. Send an Idempotency-Key header with any request that changes data: a fresh value (a UUID works) for each change you intend to make, and the same value if you retry that change.
curl -X POST "https://app.productrue.com/api/v1/inventory/stock/receive" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 6f1c2a9e-3b7d-4e0a-9c51-2d8f0b4a7e13" \
-d '{"product_id": "...", "location_id": "...", "quantity": 50}'
| When you send | You get |
|---|---|
| A key for the first time | The request runs normally. |
| The same key and the same request again | The first response, replayed, with the header Idempotent-Replayed: true. Nothing runs twice. |
| The same key with a different request | 422 PLATFORM_IDEMPOTENCY_KEY_REUSED |
| The same key while the first request is still running | 409 PLATFORM_IDEMPOTENCY_IN_PROGRESS. Wait and retry. |
Keys are remembered for 24 hours. Only final answers are remembered: success, and the errors that would come back the same way every time (400, 404, 422). A server error or a rate limit is not remembered, so retrying with the same key runs the request again. Over MCP, every tool that changes data takes an idempotency_key argument and sends it as this header.
The codes below apply to API keys and connected apps alike. Every error carries a stable code. Agents should act on the code, not on the message.
| HTTP | Code | Meaning |
|---|---|---|
| 401 | UNAUTHENTICATED | The key is missing, wrong, expired or revoked. |
| 403 | PERMISSION_DENIED | Your role does not allow this. An owner or admin can change your role. |
| 403 | PLATFORM_API_KEY_READ_ONLY | The key is read only and the request would change data. |
| 403 | PLATFORM_API_KEY_MEMBERSHIP_REVOKED | The person who created the key is no longer a member of the organisation. |
| 403 | PLATFORM_API_KEY_NOT_ALLOWED | Only possible from a signed-in browser, for example managing API keys or signing out sessions. |
| 403 | PLATFORM_API_KEY_TENANT_PINNED | A key belongs to one organisation and cannot switch to another. |
| 403 | PLATFORM_AGENT_NOT_AUTHORISED | The connected app's approval no longer exists. Connect it again. |
| 404 | NOT_FOUND | No such record in this organisation. |
| 422 | VALIDATION_FAILED | details lists each failing field with its messages. Fix them and send again. |
| 429 | RATE_LIMITED | Too many requests. Wait for the Retry-After seconds. |
Over MCP, a failed tool call returns the same code, the HTTP status, the message and the failing fields as text the agent can read.
Treat a key like a password. Keep it out of code repositories and shared documents, prefer read only where that is enough, and pick an expiry.
Each key, and each connected app, may make 120 requests per minute. The limit is per key or connection, so an agent never slows down your own work in the browser. Over MCP, a tool call counts once for the MCP request and once for each API call the tool makes; most tools make one, get_account makes two.
If you need one of these, or a tool that is not on the list, tell us.
Product management for UK SMBs. Start free, scale when ready.
128 City Road, London, EC1V 2NX