On this page: Server address
Advanced · Reference
InboundX MCP
Connect an AI app such as Claude, ChatGPT or Cursor to your publisher company on InboundX. It reads your calls, campaigns, buyers, numbers and reports, and makes changes you confirm.
Server address
Server address
https://app.inboundx.io/api/mcpPaste this into the app. It asks you to sign in here and allow it once.
Connect an app
Claude
- Open Claude on the web or in the desktop app.
- Go to Settings, then Connectors, and add a custom connector.
- Paste the address above, then sign in and press Allow.
ChatGPT
- Open ChatGPT.
- Go to Settings, then Apps, and add a custom app.
- Paste the address above, then sign in and press Allow.
Cursor
- Open Cursor Settings, then MCP.
- Add a server.
- Paste the address above as its URL, then sign in and press Allow.
Any other app that supports remote MCP servers with OAuth connects the same way: add the server address and sign in when it asks.
Sign in and permissions
The app signs in with your own InboundX login (OAuth 2.1, with the address above as the resource). There is no key to copy.
The app sees and does only what you can on these pages, with the same limits as your role. If your role changes or you leave the company, it changes or stops with you.
Apps find the sign-in endpoints themselves from these documents:
| Document | URL |
|---|---|
| Authorization server metadata | https://app.inboundx.io/.well-known/oauth-authorization-server |
| Protected resource metadata | https://app.inboundx.io/.well-known/oauth-protected-resource |
Tools
The tools an app can use, each one a page of your portal. An app is only offered the tools whose page your role can open, so a teammate may see fewer.
Read
| Tool | What it does |
|---|---|
company_ | Your company's home page: today's calls supplied and routed, live calls now, the last 14 days, top campaigns and buyers, balance, and the things that need attention. |
list_ | The InboundX buyers your company sends calls to, as the portal lists them, with what each buyer lets you see (call detail, earnings, recordings). |
call_ | The campaigns, buyers, affiliates, numbers and outcomes you can filter the call list by, and today's date on your clock. |
list_ | The calls your company routed or supplied, newest first, on your company's clock: the Calls page. Filter by dates and the ids from call_filter_options. Defaults to today. |
get_ | One routed call's page: its timeline, the pings each buyer was sent and how each replied (as the portal shows them), the outcome, and its fields. Ids come from list_calls. |
report | The Reports page: calls, connected, converted and (if your role sees money) revenue and payout, grouped by day, hour, campaign, buyer, endpoint, affiliate, number or state. Defaults to today, by day. |
ping_ | The Reports page's ping failures: per buyer endpoint per day, pings sent, failures, failure rate, response times and outcomes. Defaults to today. |
list_ | Your routing campaigns, as the Campaigns page lists them. |
get_ | One campaign's page: its settings, its routing plan and its numbers. |
campaign_ | The buyer endpoints a campaign's routing plan can use, as the plan editor offers them. |
list_ | The buyers your company routes calls to, as the Buyers page lists them, with their endpoints' status. |
get_ | One routing buyer's page and its endpoints. Secrets are never shown: only whether one is set. |
get_ | One buyer endpoint: where calls and pings go, its caps, hours, filters and status. Secrets are never shown: only whether one is set. |
endpoint_ | The values an endpoint's filters can use (states, call fields), as the endpoint editor offers them. |
list_ | The InboundX offers you can add as a routing buyer, as the add-buyer page offers them. |
list_ | Your affiliates (the sources that send you calls), as the Affiliates page lists them. |
list_ | Your phone numbers and the campaign each one is assigned to, as the Numbers page lists them. |
list_ | Your webhooks (postbacks out) from Settings: where each sends, which events, and its status. Header values are never shown: only whether one is set. |
get_ | One webhook from Settings. Header values are never shown: only whether one is set. |
webhook_ | Whether your webhooks are switched on, and how they are signed. |
list_ | Webhook deliveries from Settings: each attempt, its event, state and the reply. Defaults to today. |
list_ | Your company's keys from Settings → API keys: kind, last four characters, status and dates. A key's secret is never shown. |
billing | The Billing page: balance, overdraft, this month's usage by part and campaign, monthly statements, recent activity and rates. Owner and finance only. |
company_ | Your company on the Settings page: its name, your role and what your role can see and do, and whether routing is open for your company. |
list_ | Your company's team page: everyone who can sign in, their role, and whether they have joined or are still invited. |
supplied_ | One supplied buyer's Pings page: the pings you sent that buyer in the last 24 hours or 7 days, how many it bid on, and for the newest 100, the result in plain words. Buyer ids come from list_supplied_buyers. |
supplied_ | One supplied buyer's Conversions page: every conversion and test sent to your platform, newest first, with what your platform answered. Gives the host each one went to, to people who can see caller numbers and figures; the full address and the reply text are on the page, since they can hold your tracker key. Buyer ids come from list_supplied_buyers. |
list_ | The Caller lists page: each block or allow list, what it covers, its size and its newest numbers (last four digits, for roles that see caller numbers). |
get_ | A buyer's or an endpoint's capacity schedule: the rules that change its caps, concurrency or hours at set times or for some calls, in order. |
list_ | The skim flags on a buyer's page: buyers' endpoints flagged for short or unconverted calls, open or cleared. |
list_ | The Import page: your imports from another system's export file, newest first, with where each stands. |
get_ | One import's page: what it found, what it will create or update, the choices it needs, and whether it is ready to apply. |
list_ | The Registrations page: people who signed up as your affiliate or buyer and are waiting for you, with the affiliates and buyers you can attach them to. |
list_ | The Port numbers page: your orders to bring numbers over from another carrier, with where each stands. |
get_ | One port order's page: its numbers, status, dates, any problem the carrier raised, and its messages with the carrier's team. |
get_ | The Caller name page: the name your company's local numbers are listed under on the called person's screen, and each number's caller-name state. Toll-free numbers cannot carry one. |
supplied_ | What one of your InboundX buyers paid you: the total, paid calls, by day and by campaign with your rate, for this week, last week or the last 30 days on that buyer's invoice weeks. Use list_supplied_buyers for the buyer id. |
supplied_ | The invoices one of your InboundX buyers issued you, with what is paid and still owed. Use list_supplied_buyers for the buyer id. |
Change settings
| Tool | What it does |
|---|---|
create_ | Create a campaign, as New campaign on the Campaigns page. It starts in setup with the page's defaults (recording on with a notice to every caller, no greeting, no questions, no duplicate rule); `settings` may change any field get_campaign returns. Audio is uploaded on the page. |
update_ | Change a campaign's settings, as Save on its page. Give only the fields to change; the rest stay as they are. |
duplicate_ | Copy a campaign under a new name, as Duplicate on its page: its settings, without its numbers, plan or audio. |
set_ | Pause, unpause (set live) or archive a campaign, as on its page. A paused campaign refuses its numbers' calls before answer. Going live needs a conversion rule and an enabled routing plan row. |
set_ | Replace a campaign's routing plan, as Save on its plan: every row, in tiers (1 first) with a weight inside a tier. Endpoint ids come from campaign_plan_options. Rows left out are removed. |
create_ | Create a block or allow list for your whole company, one campaign or one buyer, with its first numbers (one per line or comma-separated). An allow list needs at least one number. |
add_ | Add numbers to a caller list (one per line or comma-separated). |
remove_ | Remove one number from a caller list. `key` is the entry's key from list_caller_lists. |
delete_ | Delete a caller list and every number on it. |
add_ | Add a buyer with its first endpoint, as Add buyer on the Buyers page. The endpoint is a phone number (`number`), a SIP address (`sip`) or one of your own offers (`workspace`, with offerId from list_own_offers); a ping (RTB) endpoint is set up on the page. |
update_ | Change a buyer's details, caps, concurrency, repeat-caller rule or notes, as Save on its page. Give only the fields to change. |
duplicate_ | Copy a buyer and its endpoints under a new name, as Duplicate on its page. |
add_ | Add an endpoint to a buyer: a phone number (`number`), a SIP address (`sip`) or one of your own offers (`workspace`). A ping (RTB) endpoint and SIP logins are set up on the page. |
update_ | Change an endpoint's settings, as Save on its page: destination, hours, caps, concurrency, dialing, filters, revenue and the rest. Give only the fields to change. Its type, ping template and logins stay as they are (change those on the page). |
duplicate_ | Copy an endpoint under a new name on the same buyer, as Duplicate on its page. |
set_ | Pause or unpause an endpoint, as its switch on the buyer page. A paused endpoint gets no calls; unpausing also clears an automatic pause. |
reset_ | Start an endpoint's cap count again for one window (hour, day, month or total), as Reset on its cap usage. |
test_ | Send the endpoint's buyer a test ping from a made-up caller, as Test on its page, and answer whether it bid. No call is made. |
set_ | Replace a buyer's or an endpoint's capacity schedule, as Save on that page: the whole list, in order, in the shape get_capacity_schedule returns. |
close_ | Close an open skim flag, as on the buyer page: `resolve` (dealt with) or `dismiss` (not a problem). |
save_ | Add an affiliate (leave out affiliate_id) or change one, as on the Affiliates page: name, sub-id, external id, payout, status (active or paused) and notes. Payout needs a role that sees figures. |
assign_ | Point one of your numbers at a campaign, an affiliate and a sub-id, as on the Numbers page. Null clears that part. A number with no campaign takes no calls. |
save_ | Add a webhook (leave out webhook_id) or change one, as Save on the Webhooks page. A new webhook's signing key is shown once on the Webhooks page, never here. Custom headers are set on the page; an edit keeps the stored URL, body and headers unless you give a new urlTemplate or bodyTemplate. |
set_ | Pause or unpause a webhook, as its switch on the Webhooks page. |
test_ | Queue one made-up event to a webhook, as Send test on the Webhooks page. Its delivery shows in list_webhook_deliveries, marked as a test. |
set_ | Switch all your webhooks' deliveries on or off, as the switch on the Webhooks page. Off, events wait and nothing is sent. |
start_ | Start an import from another system's export file, as Upload on the Import page: give the file's text. Nothing changes in your setup until apply_import. |
save_ | Save an import's choices (how each item is matched, skipped or created), as on its page, in the shape get_import_job returns them. |
apply_ | Apply an import, as Apply on its page: create and update the campaigns, buyers, endpoints, affiliates and numbers it lists. SIP logins are typed on the page; endpoints applied here get none. undo_import takes it back while nothing has used it. |
undo_ | Undo an applied import, as Undo on its page: remove what it created, unless something has used it since (it then says what). |
invite_ | Invite someone to your company, as Invite on the Team page: they get an email to sign in. Roles: staff (everything but money), finance, analyst (reports only), operator (setup, no figures). |
change_ | Change a teammate's role, as on the Team page. user_id comes from list_team. The owner's own role does not change here. |
remove_ | Remove someone from your company, as Remove on the Team page: they can no longer sign in to it. user_id comes from list_team. |
rename_ | Change your company's name, as on the Settings page. |
review_ | Approve or decline someone waiting on the Registrations page. On approve, `target_id` may attach them to one of your existing affiliates (for an affiliate sign-up) or buyers (for a buyer sign-up); left out, a new one is made. |
check_ | Check whether numbers can be brought over, as Check on the Port numbers page (one per line or comma-separated). Nothing is ordered. |
create_ | Start a port order (a draft) for numbers, as Start on the Port numbers page, with the campaign, affiliate and sub-id they will point at once they land. The owner's details, signing and submitting are done on the page. |
refresh_ | Ask the carrier for a port order's latest status, as Refresh on its page. |
send_ | Write to the carrier's porting team on a port order, as on its page. |
set_ | Set the caller name your numbers are listed under (letters, digits and spaces, 15 at most), or null to go back to your company's own name. Numbers already listed are sent again with it. Owner only. |
set_ | Turn the caller name on or off for some of your local numbers (500 at most), optionally with a number's own name (own_name: text sets it, null clears it, leave it out to keep it). Owner only. |
Billing and numbers
| Tool | What it does |
|---|---|
top_ | A link to your Billing page with an amount filled in, to add money to your company's balance. Nothing is charged here: the person opens the link, signs the agreement and pays on that page. Owner or finance only. |
turn_ | Turn off your company's automatic top-up, so the card is no longer charged when the balance runs low. Company owner only. Turning it on or changing its limits happens on the Billing page, where the owner signs for their card. |
search_ | Search phone numbers your company can buy, with this month's price. Local numbers by area code or state; toll-free by prefix. Nothing is bought. Owner or finance only. |
buy_ | Buy a number from search_numbers. The first month is taken from your balance. Optionally assign it to a campaign and affiliate. Owner or finance only. Two steps: a preview with the price, then a confirm. |
release_ | Give one of your numbers back: calls to it stop and its monthly rent stops. It cannot be undone, and the number may go to someone else. Owner or finance only. Two steps: a preview, then a confirm. |
A tool that changes something takes two steps: it first shows what would happen, and acts only when the app sends the confirmation back.
Next: Status →