Permissions

Create an API key in the dashboard under Settings > API Keys. Each key has only the scopes you assign. Update those scopes on the key after create. A request without the required scope returns 403.

organizations:read — View the organization profile and statementsmembers:read — List organization members

fbo_accounts:read — View FBO accounts, intake addresses, shipping addresses, and aliasesfbo_accounts:create — Create FBO accountsfbo_accounts:update — Update FBO accounts, addresses, and aliases

inventory:read — View inventory items and catalog products

inbound_shipments:read — View inbound shipmentsinbound_shipments:create — Create inbound shipments and quote labelsinbound_shipments:update — Update or cancel inbound shipments

outbound_shipments:read — View outbound shipmentsoutbound_shipments:create — Create outbound shipments and quote ratesoutbound_shipments:update — Cancel outbound shipments

Transfer endpoints use the transfer_batches permission resource.transfer_batches:read — View transferstransfer_batches:create — Create transferstransfer_batches:update — Confirm or cancel transfers

webhooks:manage — Create, list, and delete webhooks

Overview

Organizations

FBO Accounts

Products

Inventory

Inbound Shipments

Transfers

Outbound Shipments

Webhooks

Statements