# Container Trade HQ API > Every capability of Container Trade HQ is one POST under https://api.containertradehq.com/v1/cap/, and the MCP tools at https://api.containertradehq.com/mcp are the same capabilities. Generated from the capability registry; never edited by hand. Input revision: fa5200f22a1157a430469d906dfd492defc024c655730ab5cad32f524e5658d7 API version: 2026-10-01 (send it as Trade-HQ-Version) ## Specifications - [OpenAPI 3.1](https://containertradehq.com/openapi.json): every REST operation, its security and its refusals ## Capabilities - [acknowledge_push](https://containertradehq.com/docs/capabilities/acknowledge_push): Open a push. Records that the caller opened a push sent to them, and answers what it was about: the capability event or the exception, by id. - [add_file](https://containertradehq.com/docs/capabilities/add_file): Add a file. Adds one small file to the org from its bytes (base64, up to 180,000 bytes decoded), to be filed as a person's upload is. - [advance_flag_wave](https://containertradehq.com/docs/capabilities/advance_flag_wave): Advance a flag to its next wave. Moves one registered feature flag one wave up in PostHog: to staff if PostHog does not have it or it is off, then to the beta lists, then 10%, 25% and 50% of customer orgs, then everyone. - [announce_deprecated_versions](https://containertradehq.com/docs/capabilities/announce_deprecated_versions): Announce deprecated API versions. Trade HQ staff, after a release that supersedes an API version: emails the admins of every org holding an active API key pinned to a superseded version that it is deprecated, the day it stops being served, and how to re-pin the key. - [anonymize_user](https://containertradehq.com/docs/capabilities/anonymize_user): Anonymize a user. Permanently anonymizes a user; it cannot be undone. - [approve_grant](https://containertradehq.com/docs/capabilities/approve_grant): Decide a staff access request. An admin of the org approves or rejects a Trade HQ staff member's request for access to it. - [break_glass_access](https://containertradehq.com/docs/capabilities/break_glass_access): Break glass into a customer org. Sage or Sonja enters a customer org at once, without asking, at a level (act unless said) for a few hours (four unless said, at most twenty-four). - [cancel_org_deletion](https://containertradehq.com/docs/capabilities/cancel_org_deletion): Cancel an org's deletion. Stops an org's deletion countdown and returns the org to the state it was in when the deletion was scheduled: live, or suspended. - [check_ip_allowlist](https://containertradehq.com/docs/capabilities/check_ip_allowlist): Check my address against an org's IP allowlist. Answers the address this request came from, as the org's IP allowlist reads it, whether the allowlist allows it and which range does, the allowlist's mode and who it applies to, and whether enforce mode is available on this deployment. - [claim_depot](https://containertradehq.com/docs/capabilities/claim_depot): Claim a depot's BFC. Claims a depot's BIC Facility Code (BFC) in the depot registry for the org that runs the yard, and sets it on the org's depot unit. - [claim_party](https://containertradehq.com/docs/capabilities/claim_party): Claim an org's party. Claims a party in the party directory as an org's own, which joins the org to the trade graph: the documents that seat that party are then the org's to read as a counterparty. - [clone_role_template](https://containertradehq.com/docs/capabilities/clone_role_template): Clone a role template. Makes the org's own copy of a role template, shipped or one of the org's clones, under a new title, adding the permissions in `grant` and removing those in `revoke`. - [close_access_review](https://containertradehq.com/docs/capabilities/close_access_review): Close an access review. Closes an access review once every item is decided, and writes its evidence document: who decided what, and when. - [complete_upload](https://containertradehq.com/docs/capabilities/complete_upload): Finish a file upload. Finishes an upload create_upload started, once the bytes have been PUT to its link: checks the object is the declared size and type and hands it to be filed. - [confirm_purchase_order](https://containertradehq.com/docs/capabilities/confirm_purchase_order): Confirm a purchase order as its supplier. For the supplier of an org's purchase order (a guest of the org in the seller seat, or a member of the supplier's own Trade HQ org): confirms the purchase order with the lines you will supply, and optionally your pro forma number and the date the units will be ready. - [confirm_report](https://containertradehq.com/docs/capabilities/confirm_report): Confirm a report works now. Tells Trade HQ support that a Fixed or Answered report of your org works now for you. - [convert_sandbox](https://containertradehq.com/docs/capabilities/convert_sandbox): Convert a sandbox to a customer. Turns a public sandbox into a paying customer's organization, after the deal is signed. - [create_access_review](https://containertradehq.com/docs/capabilities/create_access_review): Start an access review. Starts an access review of an org: a list of everyone and everything that holds access to it now, of the kinds chosen (members, guests, service_accounts, api_keys, staff_grants), for its admins to decide one by one with decide_access_review_item: keep it, change a member's role, or revoke it. - [create_account](https://containertradehq.com/docs/capabilities/create_account): Create an account. Creates an account: the commercial relationship a customer's orgs belong to. - [create_api_key](https://containertradehq.com/docs/capabilities/create_api_key): Create an API key. Issues an API key on an org: sk_live_ reaches the org, sk_test_ its test twin. - [create_data_share](https://containertradehq.com/docs/capabilities/create_data_share): Share data with a counterparty. Shares one saved query of the org's data with a counterparty party, delivered to the recipients by email on a daily or hourly digest. - [create_invite_link](https://containertradehq.com/docs/capabilities/create_invite_link): Create an invite link. Creates a link that invites whoever opens it into an org, optionally with a role template, valid for 1 to 30 days (7 by default). - [create_org](https://containertradehq.com/docs/capabilities/create_org): Create an org. Creates an org with a name and a type (internal, demo or customer), optionally in an account, and returns its id. - [create_portfolio](https://containertradehq.com/docs/capabilities/create_portfolio): Create a portfolio. Creates an empty portfolio, a named set of orgs, in an account or, for staff, in no account. - [create_service_account](https://containertradehq.com/docs/capabilities/create_service_account): Create a service account. Makes a service account on an org: a non-human principal that owns API keys and acts under its own role template. - [create_sso_connection](https://containertradehq.com/docs/capabilities/create_sso_connection): Add a single sign-on connection. Adds a single sign-on connection (SAML or OIDC) for one email domain this org has verified. - [create_unit](https://containertradehq.com/docs/capabilities/create_unit): Create a unit. Creates a unit (a division, region, depot or office) in an org's unit tree, beneath a parent unit or as a root, and returns its id. - [create_upload](https://containertradehq.com/docs/capabilities/create_upload): Start a file upload. Starts uploading one file into the org: answers a link that accepts one PUT of exactly the declared size and content type, for ten minutes. - [deactivate_user](https://containertradehq.com/docs/capabilities/deactivate_user): Deactivate a user. Marks a user deactivated: this is what the admin console's Delete button does. - [decide_access_review_item](https://containertradehq.com/docs/capabilities/decide_access_review_item): Decide an access review item. Decides one item of an open access review, and does what the decision says: keep leaves it as it is; change_role gives a member the role template role_template_id; revoke deactivates a member, revokes a guest, disables a service account (and every key of it), revokes an API key or ends a staff grant. - [decline_data_share](https://containertradehq.com/docs/capabilities/decline_data_share): Stop receiving a data share. Stops a data share another org made with this org: nothing more is sent to its addresses, and the org that made it sees that this org declined it. - [delete_file](https://containertradehq.com/docs/capabilities/delete_file): Delete a file. Deletes one of the org's files. - [delete_role_template](https://containertradehq.com/docs/capabilities/delete_role_template): Delete a role template. Deletes one of the org's own role templates. - [delete_sso_connection](https://containertradehq.com/docs/capabilities/delete_sso_connection): Delete a single sign-on connection. Deletes a single sign-on connection. - [delete_view](https://containertradehq.com/docs/capabilities/delete_view): Delete a saved view. Deletes a saved view: the caller's own, or one shared org-write. - [disable_service_account](https://containertradehq.com/docs/capabilities/disable_service_account): Disable a service account. Disables a service account for good and revokes every API key it holds, in one step: its keys stop working at once. - [export_audit_events](https://containertradehq.com/docs/capabilities/export_audit_events): Export an org's audit log. Exports the audit log of one org, with the filters list_audit_events takes (event, actor, impersonation, admin alerts, a UTC date range; staff may add the acts on no org), to a CSV and a JSON file. - [follow_report](https://containertradehq.com/docs/capabilities/follow_report): Follow a customer report. Follows a customer report: it then shows unread to the caller when it changes, and its updates reach them. - [get_acting_scope](https://containertradehq.com/docs/capabilities/get_acting_scope): Get where my session acts. Answers where the signed-in user's session acts: at an account, an org or a unit, with each one's name. - [get_api_usage](https://containertradehq.com/docs/capabilities/get_api_usage): Get API usage. Counts the requests the org's API keys made, per key per UTC day, newest day first: how many were served and how many were refused for passing a key's limits. - [get_data_policy](https://containertradehq.com/docs/capabilities/get_data_policy): Get a role template's data policy. Returns one role template's data policy: which records its members reach (record_scope) and, for commercial, financial and personal fields, whether they read them (allowed, masked or denied) and export them (allowed or denied). - [get_file](https://containertradehq.com/docs/capabilities/get_file): Get a file. Reads one of the org's files: its record and, up to 180,000 bytes and where the caller's data policy reads its class, its bytes (base64). - [get_identity_sync](https://containertradehq.com/docs/capabilities/get_identity_sync): Get an org's Clerk sync state. Answers how an org's Clerk sync stands: when the reconcile last finished for it (nightly at 02:00 PT), how many role differences, memberships Trade HQ did not decide and missing memberships are open, what the org's drift setting does with them (quarantined or alerted), and how many of Clerk's events for it are waiting or failed, the failed ones named. - [get_impersonation](https://containertradehq.com/docs/capabilities/get_impersonation): Read an impersonation you started. Answers an impersonation the caller started with impersonate_user, as it stands: pending until Clerk issues the one-time sign-in link, then ready with the link until it expires; failed, expired or ended otherwise. - [get_my_settings](https://containertradehq.com/docs/capabilities/get_my_settings): Get my settings. Reads the caller's own effective settings in the org: every key with its value, the level it came from (platform, account, org or user) and the level that locks it, if any. - [get_notification_policy](https://containertradehq.com/docs/capabilities/get_notification_policy): Read an org's notification settings. Lists the org's six notice kinds in order: the audit log digest, admin activity alerts, staff access requests, break-glass access, deletion notices and announcements. - [get_onboarding_status](https://containertradehq.com/docs/capabilities/get_onboarding_status): Get an org's onboarding checklist. Returns the org's onboarding checklist: each provisioning step (account, org, Clerk organization, admin invite, entitlements, welcome mail) with its state, then whether the org has an admin and a first unit, whether all of it is complete, and the first item that is not. - [get_purchase_order_suggestions](https://containertradehq.com/docs/capabilities/get_purchase_order_suggestions): Get purchase order suggestions. From the org's own past purchase orders: for a supplier, the origin market and yard its purchase orders were most often picked up at, with how many name that yard; for a lane (an origin market and a destination market), the median days from P/U Date to the first gate-in at a depot in the destination market, with how many purchase orders had both. - [get_purge_readiness](https://containertradehq.com/docs/capabilities/get_purge_readiness): Read whether an org's purge is ready. For an org whose deletion is scheduled: whether its purge may be approved and run, as a checklist of three lines, Countdown ended, Dry run and Approvals, each pass, fail or pending with one line of evidence. - [get_report](https://containertradehq.com/docs/capabilities/get_report): Get a customer report. One customer report: everything list_reports answers for it, the reporter's own words, the page and record it was filed from, the report it reopens, who follows it, its timeline oldest first (each status and window change, note, reply, confirmation, reopen and follow, with its time) and the newest event the caller has seen. - [get_security_policy](https://containertradehq.com/docs/capabilities/get_security_policy): Get an org's security settings. Answers the org's security settings, every section: sso, mfa, session, network and drift. - [get_supplier_purchase_order](https://containertradehq.com/docs/capabilities/get_supplier_purchase_order): Get a purchase order as its supplier. For the supplier of an org's purchase order (a guest of the org in the seller seat, or a member of the supplier's own Trade HQ org): the purchase order as sent, with the buyer's name, when it was placed, the depot it is delivered to and the lines ordered with their unit prices; the confirmation, if posted, with every line that differs from the order; every update posted; the units confirmed and the unit numbers submitted; and what to do next. - [get_tenant_health](https://containertradehq.com/docs/capabilities/get_tenant_health): Get tenant health. Reads one org's health over the last 30 days: when a member last signed in, how many members were active, how many documents it ingested and what share of them failed, its plan tier and member count, and how many exceptions are open. - [get_test_twin](https://containertradehq.com/docs/capabilities/get_test_twin): Get an org's test twin. Returns the test twin of an org: the org of its own that test mode acts in, whose members, roles, units and settings mirror the live org and whose business data is its own. - [get_view](https://containertradehq.com/docs/capabilities/get_view): Open a saved view. Opens a saved view the caller may read: re-runs its stored call (capability and args) as the caller, now, under the caller's own permissions and data policy, never the owner's, and answers the view and the call's first page. - [get_view_default](https://containertradehq.com/docs/capabilities/get_view_default): Get the view in force. Answers which saved view a screen opens with for the caller (mode sales: the Sales catalog), and why: the view they opened (view_id), else their own default, else the org default an org admin set, else none, the four fixed keys (market, size, type, condition) with nothing split. - [grant_capability](https://containertradehq.com/docs/capabilities/grant_capability): Grant a capability to an org. Gives one org one capability outside its plan tier: as a grant (any capability, for a design partner or a deal) or as an add-on (bought on top; only a capability sold as one). - [grant_staff_role](https://containertradehq.com/docs/capabilities/grant_staff_role): Grant a staff role. Gives a member of Trade HQ's Internal org one of the four staff roles: staff_read, staff_ops, staff_provision or staff_finance. - [grant_unit_role](https://containertradehq.com/docs/capabilities/grant_unit_role): Give access on a unit. Gives a member of the org a role template on one unit. - [hide_catalog_photo](https://containertradehq.com/docs/capabilities/hide_catalog_photo): Hide a catalog photo. Hides one of the org's unit photos from the sales catalog, or shows it again with hidden false. - [impersonate_user](https://containertradehq.com/docs/capabilities/impersonate_user): Sign in as a customer's user. Staff operations, holding an active act grant to the org, signs in as one of its members to see what they see, for a number of minutes (thirty unless said, at most four hours). - [import_units](https://containertradehq.com/docs/capabilities/import_units): Import units from a CSV. Creates many units at once from a CSV file, and claims each depot's BIC Facility Code (BFC) in the same pass. - [import_users](https://containertradehq.com/docs/capabilities/import_users): Import users. Invites a list of up to 500 people into an org in one step, each exactly as invite_user would, optionally all with one role template. - [invite_guest](https://containertradehq.com/docs/capabilities/invite_guest): Invite a guest from a document. Invites the person behind one of a document's parties, by email address, as a guest of the org that owns the document. - [invite_user](https://containertradehq.com/docs/capabilities/invite_user): Invite a user. Invites a person, by email address, into an org, optionally with a role template. - [list_access_reviews](https://containertradehq.com/docs/capabilities/list_access_reviews): List access reviews. Lists the org's access reviews, newest first: each one's name, what it covers, when it is due, its status (open, overdue or closed), how many items it holds and how many are decided, and once closed who closed it and its evidence document. - [list_account_members](https://containertradehq.com/docs/capabilities/list_account_members): List an account's role holders. Lists who holds a role in an account, owners first, a page at a time: each person's name, email address, account role, how many of the account's entities they belong to, and who added them when. - [list_accounts](https://containertradehq.com/docs/capabilities/list_accounts): List accounts. Lists accounts, ordered by account id, a page at a time. - [list_agent_reads](https://containertradehq.com/docs/capabilities/list_agent_reads): List agent reads. Lists what Trade HQ's agents read of the org's business content, newest first: each read's agent, the records it read (purchase orders, invoices, orders), the kinds of fields it was answered, those masked and those your own data policies deny, how many records, and the purpose it stated, a ticket when there is one. - [list_announcements](https://containertradehq.com/docs/capabilities/list_announcements): List what is showing to an org. Lists what is showing now to the members of one org: the maintenance banner, if it is on, and then the announcements published to the org's account that have not ended, newest first. - [list_api_keys](https://containertradehq.com/docs/capabilities/list_api_keys): List API keys. Lists the org's API keys, newest first, a page at a time: each key's id and public prefix, name, mode (live or test), status (active, expiring, expired or revoked), the API version it is pinned to, its limits, and the key it was rotated from or into. - [list_audit_events](https://containertradehq.com/docs/capabilities/list_audit_events): List an org's audit events. Lists the audit log of one org, newest first, a page at a time: every act on the org through the capability plane, with the actor, the scope the call acted in, the state before and after, and whether staff acted inside the org on platform authority. - [list_audit_exports](https://containertradehq.com/docs/capabilities/list_audit_exports): List an org's audit log exports. Lists the exports of one org's audit log, newest first: whether each is running, ready or failed, the filters it was asked with, how many events it holds, why it failed, and, while a ready export's links last (24 hours from when it finished), a signed download link for its CSV and its JSON file. - [list_beta_lists](https://containertradehq.com/docs/capabilities/list_beta_lists): Beta lists. Lists the beta lists flags can target: each list's name, what it is for, the person property that is the list in PostHog, and where it is declared. - [list_beta_members](https://containertradehq.com/docs/capabilities/list_beta_members): Beta testers and who agreed. Lists every org and user on each beta list, with who at the customer agreed to test early and when, who on staff added them, and whether they were added here or declared in the repository. - [list_capability_events](https://containertradehq.com/docs/capabilities/list_capability_events): List capability events and their delivery. Lists every capability event, newest first, a page at a time, each with its delivery to the consumers: whether it was delivered, how many tries and replays, and when and by whom it was last replayed. - [list_catalog](https://containertradehq.com/docs/capabilities/list_catalog): List catalog. Lists an org's sales catalog a line at a time: one line per market, depot, size, type, condition, colour and hardware, with its unit counts. - [list_data_fields](https://containertradehq.com/docs/capabilities/list_data_fields): List the data field classes. Lists the four field classes a role template's data policy is written in (commercial, financial, personal, operational), each with examples, the capability fields and database columns it covers, and how many. - [list_data_shares](https://containertradehq.com/docs/capabilities/list_data_shares): List data shares. Lists what an org shares with its counterparties: for each party holding a seat on the org's documents, that floor (which is derived and cannot be revoked), and each explicit share of a saved query. - [list_depot_references](https://containertradehq.com/docs/capabilities/list_depot_references): List an org's depot links. Lists the org's own links to depots it uses (reference_depot): its name and code for each yard, the yard's BIC Facility Code (BFC) and its name in the registry, and who made the link and when. - [list_depot_registry](https://containertradehq.com/docs/capabilities/list_depot_registry): List the depot registry. Lists the depot registry, the one register of container depots every Trade HQ tenant sees the same, keyed on the BIC Facility Code (BFC) and ordered by it, a page at a time. - [list_devices](https://containertradehq.com/docs/capabilities/list_devices): List my devices. Lists the caller's own devices, newest first, revoked ones included: each with its platform, app version, the org it was bound in, whether it is a managed (shared) device, whether it receives push, when it was bound and revoked, and whether it is the device making this call. - [list_document_parties](https://containertradehq.com/docs/capabilities/list_document_parties): List a document's parties. Lists the parties on one commercial document (a purchase order is an asset_intake, a lease or sale is an order) and the seat each holds. - [list_domains](https://containertradehq.com/docs/capabilities/list_domains): List an org's email domains. Lists every email domain the org has claimed with verify_domain, pending or verified, ordered by domain. - [list_files](https://containertradehq.com/docs/capabilities/list_files): List files. Lists the org's files, newest first, a page at a time, optionally one kind. - [list_flag_actions](https://containertradehq.com/docs/capabilities/list_flag_actions): List the flag changes made from the Flags page. Lists the changes made from the Flags page, newest first: who made each one, which flag or beta list, from what to what, when, and whether PostHog took it. - [list_flag_staff](https://containertradehq.com/docs/capabilities/list_flag_staff): Staff by name, for the Flags page. Lists every person holding a Trade HQ staff role, once each, with their name and status (active, deactivated or anonymized), ordered by person: the names the Flags page shows for who made a move and offers for who agreed. - [list_flags](https://containertradehq.com/docs/capabilities/list_flags): List the feature flags. Lists every feature flag in the registry with its state in PostHog: kind, owner, purpose, decide-by date, failure default, the wave it is on (staff, beta, a percentage of customer orgs, everyone, off, absent from PostHog, or a custom rule), the next wave up, its age and a link to it in PostHog, and the drift check's findings. - [list_fx_rates](https://containertradehq.com/docs/capabilities/list_fx_rates): List FX rates. Lists the FX rates an org converts with on one day, as units of each currency per one `per` (EUR unless given). - [list_granted_capabilities](https://containertradehq.com/docs/capabilities/list_granted_capabilities): List an org's capability grants. Lists the capabilities an org was given outside its plan tier, newest first, a page at a time: each grant or add-on, who gave it, how, when, why, its expiry, and its status (active, expired or revoked) with who revoked it and why. - [list_guest_documents](https://containertradehq.com/docs/capabilities/list_guest_documents): List my documents as a guest. For a guest of an org: the documents their party holds a seat on in that org, at their seat, and nothing else of the org. - [list_guests](https://containertradehq.com/docs/capabilities/list_guests): List an org's guests. Lists the guests of an org: the people invited from its documents to read the documents their party holds a seat on. - [list_identity_findings](https://containertradehq.com/docs/capabilities/list_identity_findings): List an org's Clerk drift findings. Lists the differences the drift detector found between Clerk and Trade HQ in an org: a Clerk membership Trade HQ did not decide (quarantined: refused here and removed from Clerk), a Clerk role that is not the member's role template's (put back), or an active member Clerk holds no membership for. - [list_inventory](https://containertradehq.com/docs/capabilities/list_inventory): List inventory. Lists an org's units a page at a time: filtered by acquisition, availability, custody, depot, size, type, condition, in_depot_since, gated_out, acquisition_channel, holding_basis, vendor_bill_paid, vendor_eta, repair_state, customer, vendor and tag, all of them ANDed, and by q, the start of an identifier. - [list_my_notifications](https://containertradehq.com/docs/capabilities/list_my_notifications): List my notifications. Lists the notice kinds the caller's role can already see in the org, in the page's order, each with its state: fixed (sent to them by code, as an org admin), required (the org's notification settings names them), opted_in (they added it themselves), on (Report updates, sent by default until they turn it off) or available (they may add it with set_my_notification). - [list_org_grants](https://containertradehq.com/docs/capabilities/list_org_grants): List the staff access grants to an org. Lists every Trade HQ staff access grant to the org, newest first: who, at which level, why, until when, and whether it is waiting, active, rejected, revoked or expired. - [list_orgs](https://containertradehq.com/docs/capabilities/list_orgs): List orgs. Lists orgs, ordered by org id, a page at a time. - [list_permissions](https://containertradehq.com/docs/capabilities/list_permissions): List permissions. Lists the permission catalog: every permission a capability declares, with what it lets someone do, where it is held, whether a role template may carry it and whether such a role may be given on a unit or only on the whole org, the capabilities it admits to, and whether your role in the given org carries it. - [list_portfolios](https://containertradehq.com/docs/capabilities/list_portfolios): List portfolios. Lists portfolios, ordered by portfolio id, a page at a time. - [list_purchase_orders](https://containertradehq.com/docs/capabilities/list_purchase_orders): List purchase orders. Lists an org's purchase orders a page at a time, those with no containers yet included: each with its number, supplier, type and status, its origin (origin market, origin depot, P/U Date), its destination (destination market, destination depot, ETA), the transit days between P/U Date and ETA, and how many of its containers have landed. - [list_received_data_shares](https://containertradehq.com/docs/capabilities/list_received_data_shares): List data shares received. Lists the data shares other orgs have made with an org: every share made to the party the org has claimed, from whom, what, to which addresses and how often. - [list_report_opens](https://containertradehq.com/docs/capabilities/list_report_opens): List my report opens. Lists how often the caller opened each report in an org over the last 90 days, most opened first, then by report name: one item per report opened, with its count and when it was last opened. - [list_reports](https://containertradehq.com/docs/capabilities/list_reports): List customer reports. Lists the reports an org filed with Trade HQ support (feedback, problems and questions), newest first, a page at a time: each with its reference (CUS-n), title, kind, how and by whom it was filed, its status in plain words (received, waiting on you, planned, fixed, answered, won't fix, duplicate) and when it got there, a planned report's window, the note written for the customer, and whether the person asking follows it and has seen its latest change. - [list_role_templates](https://containertradehq.com/docs/capabilities/list_role_templates): List role templates. Lists the role templates an org can assign: the shipped bundles (Owner, Admin, Ops, Sales, Finance, Read-only, Developer and one Counterparty per seat), which cannot be changed, and the org's own clones. - [list_saved_views](https://containertradehq.com/docs/capabilities/list_saved_views): List saved views. Lists the saved views a member may open in an org: the system views every org has, then the member's own views and the ones shared with the org, pinned first and then most recently changed. - [list_service_accounts](https://containertradehq.com/docs/capabilities/list_service_accounts): List service accounts. Lists the org's service accounts, newest first: each one's org, primary and backup owner, role template, mode (live or test), status (active, suspended, disabled or expired), how many working API keys it holds, when it expires, and when a key of it was last used. - [list_sessions](https://containertradehq.com/docs/capabilities/list_sessions): List an org's active sessions. Lists the org's active sessions, most recently active first: each with the person, whether it is a sign-in or an MCP connection, when it started and was last seen, where (a masked address and the browser), how the person signed in, and whether it is the session making this call. - [list_shared_catalog](https://containertradehq.com/docs/capabilities/list_shared_catalog): List a shared catalog. Lists the catalog lines of a share another org sent you, a line at a time: one line per market, depot, size, type, condition, colour and hardware, with its available units. - [list_sso_connections](https://containertradehq.com/docs/capabilities/list_sso_connections): List an org's single sign-on connections. Lists the org's single sign-on connections (SAML or OIDC through Clerk), ordered by name. - [list_staff](https://containertradehq.com/docs/capabilities/list_staff): List Trade HQ staff. Lists every staff role held in Trade HQ's Internal org: one item per person and role, with their name, email address, status (active, deactivated or anonymized), the role, who granted it and when. - [list_staff_grants](https://containertradehq.com/docs/capabilities/list_staff_grants): List staff access grants. Lists Trade HQ staff access grants, newest first. - [list_supplier_posts](https://containertradehq.com/docs/capabilities/list_supplier_posts): List a purchase order's supplier updates. For the buyer: what the supplier of one of the org's purchase orders has posted on it, newest first: its confirmation (with every line that differs from the line ordered, and whether it has been applied), its production updates with their ready dates and notes, and the batches of unit numbers it submitted. - [list_switchable_orgs](https://containertradehq.com/docs/capabilities/list_switchable_orgs): List the orgs I can switch to. Lists the orgs the signed-in user can switch to, ordered by name. - [list_unit_access](https://containertradehq.com/docs/capabilities/list_unit_access): List access by unit. Lists who holds a role on a unit (the unit's own grants first, then those inherited from the units above it), or, given a member instead, the units that member holds a role on. - [list_units](https://containertradehq.com/docs/capabilities/list_units): List units. Lists an org's unit tree depth first, siblings by name, a page at a time, or only the subtree beneath one unit. - [list_user_factors](https://containertradehq.com/docs/capabilities/list_user_factors): List the second factors of an org's members. Lists every member of the org with the kinds of factor they have enrolled (totp, sms, backup_code, passkey), whether one is a second factor that meets an MFA requirement, whether the org's MFA requirement reaches them, and when their grace ends. - [list_users](https://containertradehq.com/docs/capabilities/list_users): List users. Lists an org's members and pending invitees, ordered by user id, a page at a time. - [mark_report_seen](https://containertradehq.com/docs/capabilities/mark_report_seen): Mark a customer report seen. Marks a customer report seen by the caller, through one event of its timeline (through, an event's at) or, left out, its newest: it then shows unread to them only once something newer happens. - [move_unit](https://containertradehq.com/docs/capabilities/move_unit): Move a unit. Moves a unit, with everything beneath it, to a new parent unit in the same org, or to the root. - [pin_view](https://containertradehq.com/docs/capabilities/pin_view): Pin a saved view to a tab's Home. Pins a saved view to a tab's Home (depots, sell, source or intel) as a card, or with pinned false takes the pin down. - [post_production_status](https://containertradehq.com/docs/capabilities/post_production_status): Post a purchase order's production status. For the supplier of an org's purchase order: says where its units are in production (scheduled, in production, produced, ready for pickup, delayed), optionally with the date they will be ready and a note. - [preview_data_share](https://containertradehq.com/docs/capabilities/preview_data_share): Preview a data share. Renders exactly what a counterparty sees of a data share: the saved query's rows and the documents on which the party holds a seat. - [provision_account](https://containertradehq.com/docs/capabilities/provision_account): Provision an account. Creates an account, its first org, the org's Clerk Organization, the first admin's invite, the plan's entitlements and a welcome mail, and reports each step. - [provision_sandbox](https://containertradehq.com/docs/capabilities/provision_sandbox): Provision a sandbox. Creates a public sandbox for anybody, signed in or not: a test-mode-only org with sample yards and containers and no live data, and one sk_test_ API key that reaches it. - [publish_announcement](https://containertradehq.com/docs/capabilities/publish_announcement): Publish an announcement to one account. Publishes a titled message to one account. - [purge_org](https://containertradehq.com/docs/capabilities/purge_org): Approve an org's purge. Approves purging an org whose 30 day deletion countdown has ended, on one dry run: dry_run_id names the org's current dry run, which must have counted. - [record_gate_event](https://containertradehq.com/docs/capabilities/record_gate_event): Record a gate event. Records that a container crossed a depot's gate, in or out: when it happened, when Trade HQ learned it, where the report came from and its EIR if any. - [record_report_open](https://containertradehq.com/docs/capabilities/record_report_open): Record a report open. Records that the caller opened a report in an org, as one event of its own: each open is a row, never a counter, and list_report_opens counts them over the last 90 days to order the Reports list by how often the person opens each report. - [reference_depot](https://containertradehq.com/docs/capabilities/reference_depot): Reference a third-party depot. Maps an org's own name and code for a depot it uses but does not run to the depot's BIC Facility Code (BFC) in the registry, so the org's documents can name the yard its own way and still mean the canonical one. - [register_device](https://containertradehq.com/docs/capabilities/register_device): Register this device. Registers an app installation by proving it holds its key, and binds it to the signed-in user in the session's org. - [reinstate_user](https://containertradehq.com/docs/capabilities/reinstate_user): Reinstate a user. Undoes a deactivation: the user can sign in again, with their memberships and records as they were. - [remove_account_member](https://containertradehq.com/docs/capabilities/remove_account_member): Remove a person from an account. Takes a person's account role away. - [remove_depot_reference](https://containertradehq.com/docs/capabilities/remove_depot_reference): Remove a depot link. Removes one of the org's own links to a depot (reference_depot), so its documents that use the org's name or code for the yard stop resolving to that BIC Facility Code until it is linked again. - [remove_domain](https://containertradehq.com/docs/capabilities/remove_domain): Remove an email domain. Removes an email domain the org claimed with verify_domain, pending or verified. - [reopen_report](https://containertradehq.com/docs/capabilities/reopen_report): Report it again: still broken. Says a Fixed or Answered report of your org is still broken. - [replay_event_delivery](https://containertradehq.com/docs/capabilities/replay_event_delivery): Replay an event's delivery. Puts one capability event's delivery back to pending, so every consumer of it hears it again. - [reply_to_report](https://containertradehq.com/docs/capabilities/reply_to_report): Reply to a report. Replies to Trade HQ support on one of your org's reports (a problem or feedback you or a colleague sent): your words reach the support team on the report's ticket, and, when the report came in by email, its email thread too. - [request_staff_grant](https://containertradehq.com/docs/capabilities/request_staff_grant): Ask a customer org for staff access. A Trade HQ staff member asks a customer org's admins for access to it, at a level (read: what the Read-only role carries; act: what the Admin role carries) and for a number of hours (fourteen days unless said, at most thirty). - [reset_user_mfa](https://containertradehq.com/docs/capabilities/reset_user_mfa): Reset a user's multi-factor authentication. Removes every second factor of a user (authenticator app, text message, backup codes) and signs them out everywhere, so they set one up again at their next sign-in. - [resolve_identity_finding](https://containertradehq.com/docs/capabilities/resolve_identity_finding): Resolve a Clerk drift finding. Decides a finding list_identity_findings shows. - [restore_security_policy](https://containertradehq.com/docs/capabilities/restore_security_policy): Restore a section of an org's security settings. Puts one section of the org's security settings (sso, mfa, session, network or drift) back to an earlier version, by number; version 1 is the section's default. - [resume_org](https://containertradehq.com/docs/capabilities/resume_org): Resume a suspended org. Brings a suspended org back: its users, and its test twin's, can sign in again. - [revoke_api_key](https://containertradehq.com/docs/capabilities/revoke_api_key): Revoke an API key. Stops one of the org's API keys working, at once, including a key still in the overlap window of a rotation. - [revoke_capability_grant](https://containertradehq.com/docs/capabilities/revoke_capability_grant): Revoke a capability grant. Ends one grant or add-on an org was given: from then the org has that capability only if its plan tier or another live grant gives it. - [revoke_data_share](https://containertradehq.com/docs/capabilities/revoke_data_share): Revoke a data share. Revokes one explicit data share: its counterparty is sent nothing more and no longer sees it. - [revoke_device](https://containertradehq.com/docs/capabilities/revoke_device): Revoke a device. Revokes one of the caller's devices: from then on it is refused on every call, the session it signed in on included, and it is sent no push. - [revoke_grant](https://containertradehq.com/docs/capabilities/revoke_grant): Revoke a staff access grant. Ends a Trade HQ staff member's access to an org at once, whether it was a request or break-glass, active or still waiting. - [revoke_guest](https://containertradehq.com/docs/capabilities/revoke_guest): Revoke a guest's access. Ends a guest's access to the org: their guest membership and the Counterparty seat it carried go, so they no longer read any document their party is seated on in the org, and their pending invitation is withdrawn. - [revoke_sessions](https://containertradehq.com/docs/capabilities/revoke_sessions): Sign sessions out. Signs sessions out of an org at once: one session (session_id), every session of one person (user_id), or every session in the org (all: true) except the one making this call, which the answer names. - [revoke_staff_role](https://containertradehq.com/docs/capabilities/revoke_staff_role): Revoke a staff role. Takes one staff role away from a member of Trade HQ's Internal org. - [revoke_unit_role](https://containertradehq.com/docs/capabilities/revoke_unit_role): Remove access on a unit. Removes a member's role on one unit, and with it what that role gave them there and on every unit beneath it. - [roll_back_flag](https://containertradehq.com/docs/capabilities/roll_back_flag): Roll a flag back to staff only. Puts one registered feature flag back on the staff list in PostHog, from any wave, so only Trade HQ staff see the feature. - [rotate_api_key](https://containertradehq.com/docs/capabilities/rotate_api_key): Rotate an API key. Issues a successor to one of the org's API keys, with the same name, mode, API version and limits, and keeps the old key working for an overlap window (24 hours unless overlap_hours says otherwise) so the integration can switch without a gap. - [route_held_file](https://containertradehq.com/docs/capabilities/route_held_file): Route a held file. Gives a held file (one that arrived where no org could be told) the org it belongs to, so it is filed there. - [run_identity_reconcile](https://containertradehq.com/docs/capabilities/run_identity_reconcile): Reconcile an org's Clerk memberships now. Queues a reconcile of one org's Clerk memberships against Trade HQ, outside the nightly 02:00 PT run: identity-provisioner lists the org's Clerk organization on its next tick and every difference becomes a finding, as at night. - [run_purge_dry_run](https://containertradehq.com/docs/capabilities/run_purge_dry_run): Run a purge dry run. Counts what purging an org whose deletion is scheduled would delete, and deletes nothing: its rows per table, the R2 objects and bytes its attachments hold, its test twin, its data shares and the members it would leave with no org. - [save_view](https://containertradehq.com/docs/capabilities/save_view): Save a view. Saves a call of a list capability as a view: the capability, its args (filters, q, sort, fields and limit, checked by that capability as a call would be), a title, whether it is pinned, and its visibility. - [schedule_org_deletion](https://containertradehq.com/docs/capabilities/schedule_org_deletion): Schedule an org's deletion. Starts a 30 day countdown to an org's deletion and locks its users out for it. - [search_party_directory](https://containertradehq.com/docs/capabilities/search_party_directory): Search the party directory. Searches the party directory, the one registry of trading parties every Trade HQ tenant sees the same, ordered by party id, a page at a time. - [search_records](https://containertradehq.com/docs/capabilities/search_records): Search records. Searches an org's records for what was typed: orders (by invoice number, order id or customer), intake (by booking number), units (by BIC number, full or partial, with or without its check digit, and a wrong check digit still finds the unit), purchase orders (by PO number or supplier), customers and suppliers (by name), and shares (by name or a recipient's address). - [send_feedback](https://containertradehq.com/docs/capabilities/send_feedback): Send feedback or report a problem. Sends Trade HQ what you think (kind feedback) or what went wrong (kind problem), from the page you are on, for your org. - [set_account_role](https://containertradehq.com/docs/capabilities/set_account_role): Set an account role. Gives a person a role in an account, owner or member, or changes the one they hold. - [set_acting_scope](https://containertradehq.com/docs/capabilities/set_acting_scope): Set where my session acts. Sets where the signed-in user's session acts: at an account they belong to, at the session's org, or at a unit of it. - [set_api_key_limits](https://containertradehq.com/docs/capabilities/set_api_key_limits): Set an API key's limits. Sets how many requests one of the org's API keys may make per UTC minute and per UTC day; 0 means no limit. - [set_api_key_version](https://containertradehq.com/docs/capabilities/set_api_key_version): Set an API key's version. Pins one of the org's API keys to an API version: a request the key makes without a Trade-HQ-Version header is then served that version. - [set_beta_list_member](https://containertradehq.com/docs/capabilities/set_beta_list_member): Add or remove an org or user on a beta list. Adds an org or a user to a named beta list (Loadstar beta, CHS beta), recording who at the customer agreed to test early and on what date, or removes one added here. - [set_catalog_price](https://containertradehq.com/docs/capabilities/set_catalog_price): Set a catalog price. Sets Wholesale, Retail or both on a sales catalog group or split (market, size, type, condition and any split values, as summarize_catalog answers them), writing every line beneath it, or on one catalog line. - [set_customer_stage](https://containertradehq.com/docs/capabilities/set_customer_stage): Set an org's customer stage. Sets where a customer org is in Trade HQ's sales cycle: prospect, pilot, or customer, which clears the stage (an org with none is a customer). - [set_data_policy](https://containertradehq.com/docs/capabilities/set_data_policy): Set a role template's data policy. Sets one of the org's own role templates' data policy, whole: which records its members reach (record_scope) and, for commercial, financial and personal fields, whether they read them (allowed, masked or denied) and export them (allowed or denied). - [set_document_parties](https://containertradehq.com/docs/capabilities/set_document_parties): Set a document's parties. Sets the parties on one commercial document (a purchase order is an asset_intake, a lease or sale is an order) and the seat each holds, replacing the seats it had. - [set_domain_join_policy](https://containertradehq.com/docs/capabilities/set_domain_join_policy): Set a domain's join_policy. Decides what a person signing up with an address at one of the org's verified domains may do: invite_only (join only when invited) or request (they are put to the org's admins as a join request to approve or reject; nobody joins without that). - [set_flag_lists](https://containertradehq.com/docs/capabilities/set_flag_lists): Choose the beta lists a flag reaches. Sets which beta lists one registered feature flag reaches in PostHog, on the wave you saw: from staff or the beta lists it puts the flag on the lists chosen, and on a percentage of customer orgs it keeps the percentage and takes the lists chosen. - [set_fx_rate_override](https://containertradehq.com/docs/capabilities/set_fx_rate_override): Override an FX rate. Sets a manual rate for one currency against EUR on one day, for one account or, with no account and only by staff, for every account. - [set_ip_allowlist](https://containertradehq.com/docs/capabilities/set_ip_allowlist): Set an org's IP allowlist. Sets the org's IP allowlist, whole: its mode (off, monitor, which records the requests it would refuse and refuses none, or enforce), who it checks (members, API keys or both) and its ranges, each an IPv4 or IPv6 range or a single address with a label. - [set_maintenance_banner](https://containertradehq.com/docs/capabilities/set_maintenance_banner): Set the maintenance banner. Turns the platform-wide maintenance banner on with a message, or off. - [set_member_role](https://containertradehq.com/docs/capabilities/set_member_role): Set a member's role. Sets the role template a member holds in an org, which decides what they may call there, or the one a pending invitee will hold once they join. - [set_mfa_policy](https://containertradehq.com/docs/capabilities/set_mfa_policy): Set an org's multi-factor authentication requirement. Sets whether the org's members must use a second factor: off, required for all members, or required for the members whose role template is one of templates. - [set_my_notification](https://containertradehq.com/docs/capabilities/set_my_notification): Set one of my notifications. Adds a notice for the caller alone, or takes back one they added, emailed to their sign-in address. - [set_my_settings](https://containertradehq.com/docs/capabilities/set_my_settings): Set my settings. Sets or clears the caller's own settings (only keys a person may set for themselves, such as shell_last_tab, timezone and locale) and returns their effective settings in the org. - [set_my_view_default](https://containertradehq.com/docs/capabilities/set_my_view_default): Set my default view. Sets the caller's own default view for a screen (mode sales: the Sales catalog): the saved view it opens with, over the org default. - [set_notification_policy](https://containertradehq.com/docs/capabilities/set_notification_policy): Set who must receive a notice. Sets, for one notice kind of the org, the whole set of recipients it must also reach beside its fixed ones, which nothing removes: members (by user_id), outside email addresses, and Slack channels (a new one by channel_name and webhook_url, one the org already holds by its id). - [set_org_view_default](https://containertradehq.com/docs/capabilities/set_org_view_default): Set the org default view. Sets the org's default view for a screen (mode sales: the Sales catalog), which every member opens with unless they set their own. - [set_portfolio_members](https://containertradehq.com/docs/capabilities/set_portfolio_members): Set a portfolio's orgs. Replaces a portfolio's orgs with the set given, and returns the set. - [set_session_mode](https://containertradehq.com/docs/capabilities/set_session_mode): Switch between live and test. Switches the caller's own session between live and test. - [set_session_policy](https://containertradehq.com/docs/capabilities/set_session_policy): Set an org's session settings. Sets how long a session lasts in the org: signed out after idle_minutes without a request (15 to 1440) and after absolute_hours from sign-in whatever happens (1 to 168, 7 days being the most Trade HQ allows), whether a change to what someone may do signs them out (reauth_on_role_change), and whether a new sign-in signs the person's older sessions out (single_session). - [set_sso_policy](https://containertradehq.com/docs/capabilities/set_sso_policy): Set an org's single sign-on settings. Sets the org's single sign-on settings for one connection and its domain: whether members at the domain must sign in through the connection (required), just-in-time membership on a first sign-in (jit) and the role template it gives (default_role_template, never the Owner), whether the IdP's MFA counts toward the org's MFA settings (idp_mfa_trusted), and allow_manual_additions. - [share_view](https://containertradehq.com/docs/capabilities/share_view): Share a saved view. Shares a saved view of the caller's: with named teammates (user_ids, each a member of the org), with the org (with_org), or both. - [step_back_flag](https://containertradehq.com/docs/capabilities/step_back_flag): Roll a flag back one wave. Moves one registered feature flag one wave down in PostHog: from everyone to 50% of customer orgs, then 25%, 10%, the beta lists, staff, and off. - [submit_serial_batch](https://containertradehq.com/docs/capabilities/submit_serial_batch): Submit unit numbers against a confirmed purchase order. For the supplier of an org's purchase order that it has confirmed: sends the ISO 6346 unit numbers of the containers it is supplying. - [subscribe_audit](https://containertradehq.com/docs/capabilities/subscribe_audit): Subscribe to an org's audit log. Subscribes an email digest or a Slack incoming webhook to an org's audit log, or changes or disables that subscription. - [summarize_catalog](https://containertradehq.com/docs/capabilities/summarize_catalog): Summarize catalog. Counts an org's sales catalog lines matching the same filters list_catalog takes, and sums their unit counts: total, available, reserved, secured, pending, available and secured, available and pending. - [summarize_inventory](https://containertradehq.com/docs/capabilities/summarize_inventory): Summarize inventory. Counts an org's units matching the same filters and q list_inventory takes (with no acquisition filter, units pending or acquired), and answers the lowest, highest and average total cost among them, and their lanes: units by origin market and destination market with the median transit days. - [summarize_purchase_orders](https://containertradehq.com/docs/capabilities/summarize_purchase_orders): Summarize purchase orders. Counts an org's purchase orders matching the same filters and q list_purchase_orders takes, sums their containers and landed containers, and answers the median transit days from P/U Date to ETA over those that have both. - [summarize_reports](https://containertradehq.com/docs/capabilities/summarize_reports): Summarize customer reports. Counts the customer reports list_reports lists for the same org_id, account_id, filters and q, reported within period (days, Pacific time; every day when left out): how many, how many stand in each status, and the median calendar days from reported to fixed and to Trade HQ's first response. - [suspend_org](https://containertradehq.com/docs/capabilities/suspend_org): Suspend an org. Suspends an org: its users, and its test twin's, are refused on every call until it is live again. - [switch_org](https://containertradehq.com/docs/capabilities/switch_org): Switch organization. Moves the signed-in user's own session to another org: every later request acts in that org. - [turn_off_flag](https://containertradehq.com/docs/capabilities/turn_off_flag): Turn a flag off. Switches one registered feature flag off in PostHog for everyone, from any wave. - [unfollow_report](https://containertradehq.com/docs/capabilities/unfollow_report): Unfollow a customer report. Stops following a customer report: it no longer shows unread to the caller, and its updates no longer reach them. - [update_org_settings](https://containertradehq.com/docs/capabilities/update_org_settings): Update an org's settings. Sets or clears an org's own settings and returns its effective settings, each with the level it came from. - [update_role_template](https://containertradehq.com/docs/capabilities/update_role_template): Edit a role template. Renames one of the org's own role templates, changes its description, and adds the permissions in `grant` and removes those in `revoke`. - [update_service_account](https://containertradehq.com/docs/capabilities/update_service_account): Update a service account. Changes a service account: its name, its primary and backup owner (both named, two different active members of the org), its role template (never Owner or Admin), or its expiry, renewed with expires_in_days to at most 365 days from now. - [update_sso_connection](https://containertradehq.com/docs/capabilities/update_sso_connection): Update a single sign-on connection. Changes a single sign-on connection: its name, its IdP metadata (idp_metadata_url, an https URL, or idp_metadata, the IdP's metadata XML), and whether people sign in through it (active). - [verify_domain](https://containertradehq.com/docs/capabilities/verify_domain): Verify an email domain. Claims an email domain for the org and verifies it.