Admin tools.
Every tool a platform owner's AI connection can use, with what it does, how safe it is and what access it needs.
On this page
The platform owner's connection acts as the super admin. This page lists every tool it can be offered. Which tools appear on a given connection depends on the access chosen when it was connected.
| What the tool does | Tools |
|---|---|
| Reads | 36 |
| Changes | 21, of which 2 wait for approval for sensitive settings |
| Waits for approval | 18 |
| Opens a tool family or runs a change you approved | 3 |
| All tools | 78, in 13 families |
How to read the tables
- Tool is the name your AI client sees. It is also the
operationIdin the OpenAPI spec. - Safety says what a call does. Reads changes nothing. Changes makes an everyday change that Reward Loyalty logs. Waits for approval only prepares the change and gives you a review link. Nothing runs until you approve it. See Approvals.
- Access lists the scopes. A connection needs one of the listed scopes, unless the cell says All of. Scopes and permissions explains each scope. Access and security shows which access choice grants them.
- Tools marked contacts an outside service send a request from your server to another system, such as a license server, a payment provider or a store.
Tools in families
A connection gets a tool list that fits its access. When the full list would be too large for an AI client, the platform keeps some families out of the list. Those tools stay available through two tools that are always in the list: admin_describe_tool_family and admin_run_family_tool. The AI client first asks which tools a family holds, then runs one by name. The same access checks and approvals apply. Which families are kept out depends on the connection's access. Ask the client to call admin_describe_tool_family to see them. The list is limited to 90 tools and 150 KB.
The tools
Platform
Overview, Health center, settings, plans, languages and translations, the license, and the scheduled tasks you can run now.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_add_language |
Add a language | Changes | write:settings |
admin_check_for_updates |
Check for a Reward Loyalty update | Changes; contacts an outside service | run:maintenance |
admin_get_activity_analytics |
Get activity log analytics | Reads | One of read:analytics, read:platform |
admin_get_health_report |
Get the Health center report | Reads | read:platform |
admin_get_language_catalogue |
Get the languages that can be added | Reads | read:platform |
admin_get_languages |
Get the language settings | Reads | read:platform |
admin_get_license_status |
Get the license and update status | Reads | read:platform |
admin_get_plans |
Get plan tiers | Reads | read:platform |
admin_get_platform_overview |
Get the platform overview | Reads | read:platform |
admin_get_saas_overview |
Get the SaaS business center | Reads | read:platform |
admin_get_settings |
Get platform settings | Reads | read:platform |
admin_get_translation_history |
Get the edit history of a translation | Reads | read:platform |
admin_preview_translation |
Check a translation before saving it | Reads | One of read:platform, write:settings |
admin_purge_activity_logs |
Purge old activity logs | Waits for approval | run:maintenance |
admin_refresh_license |
Refresh the license status | Changes; contacts an outside service | run:maintenance |
admin_reset_language_policy |
Return the language policy to the environment | Waits for approval | write:settings |
admin_reset_plan |
Reset a plan tier | Waits for approval | write:settings |
admin_reset_setting |
Reset a platform setting | Changes; waits for approval for sensitive settings such as the app URL, who can sign up and the mail sender | write:settings |
admin_run_achievement_drain |
Grant waiting achievement rewards now | Changes | run:maintenance |
admin_run_scheduled_task |
Run a scheduled task now | Changes | run:maintenance |
admin_run_webhook_drain |
Deliver waiting webhooks now | Changes; contacts an outside service | run:maintenance |
admin_search_translations |
Search translations | Reads | read:platform |
admin_test_provider_connection |
Test the connection to a billing or wallet provider | Reads; contacts an outside service | read:platform |
admin_update_language |
Change a language | Changes | write:settings |
admin_update_language_policy |
Set the language policy | Waits for approval | write:settings |
admin_update_plan |
Edit a plan tier | Waits for approval | write:settings |
admin_update_settings |
Change platform settings | Changes; waits for approval for sensitive settings such as the app URL, who can sign up and the mail sender | write:settings |
admin_update_translations |
Edit translations | Changes | write:settings |
Partners
The businesses on your platform: create, update, permissions, plan, activate, deactivate and delete.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_activate_partner |
Activate a partner | Changes | write:partners |
admin_change_partner_plan |
Move a business to another plan | Waits for approval | write:partners |
admin_create_partner |
Create a business | Changes | write:partners |
admin_deactivate_partner |
Deactivate a partner | Waits for approval | write:partners |
admin_delete_partner |
Delete a business | Waits for approval | write:partners |
admin_get_partner |
Get a specific partner with permissions and usage | Reads | read:partners |
admin_get_partner_delete_impact |
Get what deleting a partner would remove | Reads | read:partners |
admin_get_referral_funnel |
Get the partner referral funnel | Reads | read:partners |
admin_list_partners |
List all partners | Reads | read:partners |
admin_update_partner |
Update a business's profile | Changes | write:partners |
admin_update_partner_permissions |
Update partner permissions and limits | Changes | write:partners |
Members
Member accounts across every business, their history, and corrections to their last entries.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_delete_member |
Delete a member | Waits for approval | write:members |
admin_get_member |
Get a member as the admin console shows them | Reads | read:members |
admin_get_member_ledger |
Get one member's transaction history | Reads | read:ledgers |
admin_list_member_achievements |
List one member's earned achievements | Reads | read:members |
admin_list_members |
List all members platform-wide | Reads | read:members |
admin_purge_ghost_members |
Purge inactive anonymous members | Waits for approval | write:members |
admin_undo_last_pass_visit |
Undo a member's last pass visit | Waits for approval | write:members |
admin_undo_last_stamp |
Undo a member's last stamps | Waits for approval | write:members |
admin_undo_last_transaction |
Undo a member's last points transaction | Waits for approval | write:members |
admin_undo_last_voucher_redemption |
Undo a member's last voucher redemption | Waits for approval | write:members |
admin_update_member |
Update a member | Changes | write:members |
admin_void_member_achievement |
Void a member's achievement | Changes | write:members |
Member cards
Printed member cards and their batches.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_delete_unclaimed_card_codes |
Delete blank printed card codes | Waits for approval | write:members |
admin_disable_member_card |
Disable a member card | Waits for approval | write:members |
admin_get_card_batch |
Get one printed card batch with its codes | Reads | read:members |
admin_issue_member_cards |
Generate printed member cards | Changes | write:members |
admin_list_card_batches |
List printed card batches | Reads | read:members |
Networks
Groups of businesses that share a wallet.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_create_network |
Create a network | Changes | write:settings |
admin_delete_network |
Delete a network | Waits for approval | write:settings |
admin_update_network |
Update a network | Changes | write:settings |
Support
Support tickets from business owners.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_add_support_note |
Add an internal note to a ticket | Changes | write:support |
admin_get_support_ticket |
Get one support ticket with its thread | Reads | read:platform |
admin_reply_support_ticket |
Reply to a support ticket | Waits for approval | write:support |
admin_update_support_ticket |
Set a ticket's status or assignee | Changes | write:support |
Money
Stored-money accounts and sales, read only.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_get_money_overview |
List prepaid money accounts or sales | Reads | All of read:money |
admin_get_money_record |
Get one prepaid money account or sale | Reads | All of read:money |
Analytics
Platform and per-business numbers.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_analytics_overview |
Get platform-wide analytics | Reads | read:analytics |
admin_partner_metrics |
Get per-partner analytics | Reads | read:analytics |
Records
The lists you see in the admin console, with the console's filters and sorting.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_describe_records |
Describe the console lists you can read | Reads | One of read:partners, read:members, read:platform, read:ledgers |
admin_get_record |
Get one row of a console list | Reads | One of read:partners, read:members, read:platform, read:ledgers |
admin_list_records |
List rows of a console list | Reads | One of read:partners, read:members, read:platform, read:ledgers |
Search
One search across businesses, members, programs and tickets.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_search |
Search partners, members, programs and support tickets | Reads | One of read:partners, read:members, read:platform, read:partner-data |
Business data
Any business's own reads, as that business sees them.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_describe_partner_reads |
Describe the business reads you can run for any business | Reads | read:partner-data |
admin_partner_read |
Read one business's data as that business sees it | Reads | read:partner-data |
Approvals
Check and run the changes you approved.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_execute_approval |
Run an approved change | Runs a change you approved | Any scope that allows changes |
admin_get_approval |
Get one approval | Reads | One of write:partners, write:members, write:settings, write:support, run:maintenance |
admin_list_approvals |
List the approvals this connection prepared | Reads | One of write:partners, write:members, write:settings, write:support, run:maintenance |
Opening tool families
Opens the tools that are kept in families to keep the tool list small.
| Tool | What it does | Safety | Access |
|---|---|---|---|
admin_describe_tool_family |
Describe the tools kept in families | Reads | Any scope; the tool it opens decides |
admin_run_family_tool |
Run a tool from a family | Depends on the tool it runs | Any scope; the tool it opens decides |
See what your connection has
Ask your AI client to list its tools, or call GET /api/agent/v1/tools?format=mcp with the same key. The Tool discovery page lists the formats.
Some admin tasks have no tool on purpose: provider secrets, installing updates, signing in, creating keys and connections, uploads, downloads, billing checkout, and the three AI and Agent API switches. The What your AI can do section on the AI connections page shows this per area.
Related topics
- What admins can ask: example requests, grouped by job.
- Approvals: how risky changes wait for you.
- Limits, errors and retries: what a tool answers when it can't run.