Scope3

Scope3 Account API

Account management, service tokens, and preferences

GitHub OpenAPI

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /accounts/current Get my current account · Get current account #
Ask an LLM
“Which customer account am I currently working in?”
“Can I see the account context for my login?”
Tell an agent
Show my current account.
Tell me which customer account I'm signed into.
GET /accounts List accounts I belong to · List customer accounts #
Ask an LLM
“Which customer accounts do I have membership on?”
“Can I see all the orgs my user can access?”
Tell an agent
List all my customer accounts.
Show every account I'm a member of.
POST /accounts/create-child Create a child account · Create child account #
Ask an LLM
“How do I create a child account under my organization?”
“Do I need admin rights to add a child customer account?”
Tell an agent
Create a child account named {name} with role {customerRole}.
Add child account {name} as {customerRole} with default currency {defaultCurrency}.
PATCH /accounts/{customerId}/domain Update an organization's domain · Update customer domain #
Ask an LLM
“Can I change the registered organization domain for a customer?”
“Who is allowed to update a customer's domain?”
Tell an agent
Set the domain of customer {customerId} to {customerDomain}.
Update organization domain for {customerId} to {customerDomain}.
DELETE /accounts/{customerId} Delete a child account · Delete child account #
Ask an LLM
“Can I permanently delete a child customer account?”
“Why would deleting a child account fail with a conflict?”
Tell an agent destructive · confirm first
Delete child account {customerId}.
Hard-delete child customer {customerId}.
GET /accounts/{customerId}/membership Get an org's membership settings · Get membership settings #
Ask an LLM
“Is domain auto-join turned on for my organization?”
“Can I check membership settings for a customer org?”
Tell an agent
Get membership settings for customer {customerId}.
Check whether domain auto-join is enabled for {customerId}.
PATCH /accounts/{customerId}/membership Turn domain auto-join on or off · Update membership settings #
Ask an LLM
“How do I let people with my company email join automatically?”
“What's required before I can enable domain auto-join?”
Tell an agent
Set domain auto-join for customer {customerId} to {allowDomainAutoJoin}.
Enable domain auto-join on {customerId}: {allowDomainAutoJoin}.
GET /browser-origins List allowed browser origins · List browser origins #
Ask an LLM
“Which browser origins can call the MCP and OAuth endpoints for my account?”
“Can I review the CORS-allowed origins on my account?”
Tell an agent
List my allowed browser origins.
Show the origins registered for browser MCP access.
POST /browser-origins Register a browser origin · Register browser origin #
Ask an LLM
“How do I allow my web app's origin to call the MCP endpoints from a browser?”
“Can a registered browser origin include a path or wildcard?”
Tell an agent
Register browser origin {origin}.
Allow origin {origin} labeled {label} for browser MCP and OAuth calls.
DELETE /browser-origins/{id} Remove a browser origin · Delete browser origin #
Ask an LLM
“Can I revoke CORS access for a browser origin I registered?”
“What happens to an origin once I delete it?”
Tell an agent destructive · confirm first
Delete browser origin {id}.
Archive origin {id} so it loses CORS access.
GET /notification-preferences Get my notification opt-ins · Get notification preferences #
Ask an LLM
“Which notifications have I opted into?”
“Can I see my personal notification preferences?”
Tell an agent
Show my notification preferences.
List the notifications I've opted into.
PUT /notification-preferences Set my notification opt-ins · Update notification preferences #
Ask an LLM
“How do I change which notifications I receive?”
“Does updating my opt-ins replace the existing ones?”
Tell an agent
Set my notification opt-ins to {optIns}.
Replace my notification preferences with {optIns}.
GET /notification-delivery-preferences Get Slack notification settings · Get Slack notification settings #
Ask an LLM
“Are product updates and outage alerts going to our Slack channel?”
“Which Slack channel receives my account's alerts?”
Tell an agent
Show my account's Slack notification settings.
Check whether source outage alerts are on in Slack.
PUT /notification-delivery-preferences Change a Slack notification setting · Update a Slack notification setting #
Ask an LLM
“Can I turn off product update messages in our Slack channel?”
“How quickly can source outage alerts be sent to Slack?”
Tell an agent
Turn off Product Updates in our Slack channel.
Send source outage alerts to Slack after 30 minutes.
POST /market-readiness Preview market readiness by country and channel · Preview market readiness #
Ask an LLM
“Is a given country and channel open for buying yet?”
“What supply evidence exists for a market I want to enter?”
Tell an agent
Preview market readiness for cells {cells}.
Check pilot state and supply for country-channel cells {cells}.
GET /readiness Get my buyer readiness · Get buyer readiness #
Ask an LLM
“What do I still need to do before my buyer account can activate?”
“Which destinations am I ready to buy on?”
Tell an agent
Show my buyer readiness.
List per-destination buying readiness for my account.
PATCH /readiness/operator Set my buyer operator domain · Update buyer operator domain #
Ask an LLM
“How do I confirm the commercial operator domain on my buyer account?”
“Can I change my operator domain without changing the organization?”
Tell an agent
Set my buyer operator domain to {operatorDomain}.
Confirm {operatorDomain} as our commercial operator domain.
GET /accounts/liveness Check storefront liveness for seller accounts · Get storefront liveness for accounts #
Ask an LLM
“Are my sellers' storefronts live or in a critical state?”
“Can I check liveness for several seller accounts at once?”
Tell an agent
Get storefront liveness for customers {customerIds}.
Show storefront liveness verdicts for my seller accounts.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-account-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/scope3:scope3-account-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

scope3-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Scope3 Account API
  version: 2.0.0
  description: 'Operations tagged Account across 2 of this provider''s published API definitions: scope3-buyer-openapi-original.yml, scope3-storefront-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.interchange.io/api/v2/buyer
  description: Production server
- url: https://api.interchange.io/api/v2/storefront
  description: Production server
tags:


# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scope3/refs/heads/main/openapi/scope3-account-api-openapi.yml