Authenticate
Use an ordinary user-owned Effective API key with MC and filing access. Read-only keys can read. Resource-scoped, app/system, and record-bot keys are unsupported. No Captain session or active UI is needed. SetEFFECTIVE_API_BASE_URL to your deployment origin without /api/v2, and
provide EFFECTIVE_API_KEY through your client’s secret environment. Verify the
caller with GET /api/v2/users/me.
List filings
List across all active Mission Controls you can view in your tenant. There is no MC filter:filings array and nullable nextCursor. Summaries include
ID, canonical authorization scope (mc:<MC UUID>), display name, filing mode, company/jurisdiction/product IDs, tracking
numbers, description, and timestamps. Missing optional metadata is null.
filingMode distinguishes managed, read-only reference, and unclassified
legacy data (null). MC access alone does not grant access to private filings.
Repeat the limit with the returned cursor. Default page size is 50; maximum
is 100. Results are ordered by MC UUID ascending, then creation time descending
and filing ID ascending within each MC. Short/empty pages may have a continuation;
stop only at null. Cursors expire 24 hours after the first page. Changing caller
or page size invalidates them. Each call refreshes current MC and filing access;
revoked scopes are skipped. Restart the list to see newly accessible filings that
sort before your current position. No accessible filings returns an empty list.
Read one filing
SetFILING_ID to a returned ID. No MC parameter is needed:
Recover from errors
401 unauthenticated: verify the credential and whether its type is supported.403 forbidden: credential is not permitted for this operation.404 not_found: filing missing or invisible; these cases are indistinguishable.400 invalid_cursor: restart the list.400 invalid_request: correct input; unknown/repeated scalar fields are rejected.503 temporarily_unavailable: respectRetry-Afterbefore retrying the read.