FavCRM
REMOTE · API.FAVCRM.IO · SCANNED AUG 4
Agentic CRM for service businesses — bookings, customers, WhatsApp, loyalty, invoicing.
Available components
How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. How we score →
Endpoint Security89
- The endpoint's TLS certificate is valid, in date, and uses a strong key. View diagnostics → Pass
- Authorisation is enforced on tool calls, but the challenge carries no valid RFC 9728 metadata, so a client cannot discover where to get a token. See how to fix → View diagnostics → Fail
- HTTPS is enforced; there's no plaintext access path. View diagnostics → Pass
- The HSTS (Strict-Transport-Security) header is present. View diagnostics → Pass
- DNSSEC check failed: this domain isn't protected by DNSSEC. See how to fix → View diagnostics → Fail
Transport & Reachability100
- Verified streamable-http transport via a live MCP handshake. View diagnostics → Pass
Schema Quality & AI Usability85
- 100% of prompts and resources have a non-trivial description (not blank, and not just the item's name).Pass
- AI-judged instruction clarity (excellent).Pass
- Tool/resource definitions use about 18916 tokens (~82/item across 228 items; 223 tools + 5 resources), lean.Pass
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management30
- Stability observed for 9 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 100% of tool parameters carry a description.Pass
- Structured output schemas are declared (100% of tools); any adoption earns full credit.Pass
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.
remote · api.favcrm.io
claude mcp add --transport http io-favcrm-favcrm https://api.favcrm.io/mcp
[mcp_servers.io-favcrm-favcrm] url = "https://api.favcrm.io/mcp"
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"io-favcrm-favcrm": {
"type": "remote",
"url": "https://api.favcrm.io/mcp",
"enabled": true
}
}
} openclaw mcp add io-favcrm-favcrm --url https://api.favcrm.io/mcp --transport streamable-http
mcp_servers:
io-favcrm-favcrm:
url: "https://api.favcrm.io/mcp" {
"mcpServers": {
"io-favcrm-favcrm": {
"type": "http",
"url": "https://api.favcrm.io/mcp"
}
}
} The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.
Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 3 Aug 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 23 to 27. That category is still filling its 30-day observation window: 7 days of observed history at the previous scan, 8 at this one. The score rises as the window fills, whether or not the server changes.
- 1 Aug 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 17 to 20. That category is still filling its 30-day observation window: 5 days of observed history at the previous scan, 6 at this one. The score rises as the window fills, whether or not the server changes.
- 31 Jul 26 +4
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 30 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 29 Jul 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 7 to 10. That category is still filling its 30-day observation window: 2 days of observed history at the previous scan, 3 at this one. The score rises as the window fills, whether or not the server changes.
- 28 Jul 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 3 to 7. That category is still filling its 30-day observation window: 1 days of observed history at the previous scan, 2 at this one. The score rises as the window fills, whether or not the server changes.
- 27 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 26 Jul 26 74
First indexed and scored.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 4 Aug 2026 · Probed https://api.favcrm.io/mcp
TLS valid
Negotiated TLS 1.3 with TLS_AES_128_GCM_SHA256 .
| Subject | Issuer | Valid from | Valid until | Key | Signature | Serial |
|---|---|---|---|---|---|---|
| CN=favcrm.io | CN=WE1,O=Google Trust Services,C=US | 13 Jun 2026 | 11 Sept 2026 | ECDSA 256 | ECDSA-SHA256 | 8b36e4b5d46a89d8137da5f9739177d7 |
| SANs: favcrm.io, api.favcrm.io, *.api.favcrm.io | ||||||
| CN=WE1,O=Google Trust Services,C=US (CA) | CN=GTS Root R4,O=Google Trust Services LLC,C=US | 13 Dec 2023 | 20 Feb 2029 | ECDSA 256 | ECDSA-SHA384 | 7ff31977972c224a76155d13b6d685e3 |
| CN=GTS Root R4,O=Google Trust Services LLC,C=US (CA) | CN=GlobalSign Root CA,OU=Root CA,O=GlobalSign nv-sa,C=BE | 15 Nov 2023 | 28 Jan 2028 | ECDSA 384 | SHA256-RSA | 7fe530bf331343bedd821610493d8a1b |
DNSSEC insecure
Validation of api.favcrm.io. — Not signed
| Zone | DS | Keys | Algorithms | Outcome |
|---|---|---|---|---|
| . | trust_anchor | 20326, 38696 | 8, 8 | Verified |
| io. | present | 57355 | 8 | Verified |
| favcrm.io. | absent | Unsigned (proven) parent-signed NSEC/NSEC3 proves an unsigned delegation |
Authentication Challenged, unverified
The endpoint asked for a token, but we could not retrieve and validate the RFC 9728 metadata that tells a client how to obtain one.
| Result | Challenged, unverified |
|---|---|
| Enforced | On tool calls |
| HTTP status | 200 |
| Header | Value |
|---|---|
| strict-transport-security | max-age=31536000 |
| x-content-type-options | nosniff |
| x-frame-options | SAMEORIGIN |
| referrer-policy | no-referrer |
Protected resource metadata
| Retrieved | No |
|---|---|
| Problem | no_resource_metadata |
Transports 2 probes
| Transport | URL | Outcome | Status | Location |
|---|---|---|---|---|
| streamable-http | https://api.favcrm.io/mcp | Verified | 200 | |
| http (plaintext) | http://api.favcrm.io/mcp | HTTPS enforced | 301 | https://api.favcrm.io/mcp |
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.
get_order ~27
Get full order detail including line items.
| Name | Type | Req | Description |
|---|---|---|---|
| orderId | string | yes | The order UUID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_plan_status ~37
Show the current organisation plan, subscription/payment state, enabled modules, and quota usage. Use before deciding whether an agentic operation is allowed.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_post ~32
Get detailed CMS post including content blocks, categories, and tags.
| Name | Type | Req | Description |
|---|---|---|---|
| postId | string | yes | The post ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_product ~31
Get full product detail including images, options, and variations.
| Name | Type | Req | Description |
|---|---|---|---|
| productId | number | yes | The product ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_promotion ~30
Get details of a specific promotion/coupon code.
| Name | Type | Req | Description |
|---|---|---|---|
| promotionId | string | yes | The promotion ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_segment ~33
Get customer segment details including type, criteria, and live member count.
| Name | Type | Req | Description |
|---|---|---|---|
| segmentId | string | yes | The segment ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_segment_members ~43
Get the members that belong to a specific segment.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| segmentId | string | yes | The segment ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_service_detail ~35
Get full service details including addons, staff, resources, and tier pricing.
| Name | Type | Req | Description |
|---|---|---|---|
| serviceId | string | yes | The service ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_service_package ~33
Get service package detail including applicability and selected booking service/event items.
| Name | Type | Req | Description |
|---|---|---|---|
| packageId | string | yes | Service package ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_subscription ~34
Fetch a single subscription with customer, tier, billing cycle, and renewal info.
| Name | Type | Req | Description |
|---|---|---|---|
| subscriptionId | string | yes | Subscription ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_survey ~37
Get survey detail, including blocks, publishing status, visibility, settings, and response count.
| Name | Type | Req | Description |
|---|---|---|---|
| surveyId | string | yes | Survey ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_survey_responses ~40
List responses for a survey.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max responses (default 50) |
| surveyId | string | yes | Survey ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_survey_stats ~31
Get response and invitation metrics for a survey overview dashboard.
| Name | Type | Req | Description |
|---|---|---|---|
| surveyId | string | yes | Survey ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_task ~26
Get detailed task information by ID.
| Name | Type | Req | Description |
|---|---|---|---|
| taskId | string | yes | The task ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_ticket_stats ~16
Get ticket counts grouped by status.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
get_whatsapp_connection_status ~37
Check whether WhatsApp Business is connected for this company, including WABA/phone metadata and the latest agentic connect session state.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
issue_rewards ~78
Issue a gift/reward to multiple members. Requires a gift offer ID and member IDs.
| Name | Type | Req | Description |
|---|---|---|---|
| expiresAt | string | — | Optional ISO date when the reward expires |
| giftOfferId | string | yes | The gift offer/reward scheme ID to issue |
| memberIds | array | yes | Member/account IDs to receive the reward (max 50) |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
link_resource_to_service ~39
Link a room/resource to a booking service.
| Name | Type | Req | Description |
|---|---|---|---|
| resourceId | string | yes | Resource ID |
| serviceId | string | yes | Service ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_audit_logs ~176
List recent audit log entries for this company. Filter by action, resource, resourceId, user, source, outcome, destructive flag, and created date range.
| Name | Type | Req | Description |
|---|---|---|---|
| action | string | — | Exact tool/action name, e.g. delete_campaign |
| createdAfter | string | — | ISO timestamp lower bound |
| createdBefore | string | — | ISO timestamp upper bound |
| destructive | boolean | — | Whether the audited tool was destructive |
| limit | integer | — | Maximum rows to return |
| outcome | string | — | Execution outcome |
| resource | string | — | Resource name, e.g. campaigns |
| resourceId | string | — | Resource ID |
| source | string | — | Audit source, e.g. mcp, ai_agent, payment_webhook, merchant_api |
| userId | string | — | Actor user ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_bookings ~119
List bookings with filters for date range, status, service, staff, or member.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | — | Filter by member/account ID |
| dateFrom | string | — | ISO date — bookings from this date |
| dateTo | string | — | ISO date — bookings up to this date |
| limit | number | — | Max results (default 20) |
| serviceId | string | — | Filter by service ID |
| staffId | string | — | Filter by staff member ID |
| status | string | — | Filter by booking status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_campaigns ~76
List marketing campaigns (email, SMS, WhatsApp) with delivery stats.
| Name | Type | Req | Description |
|---|---|---|---|
| channel | string | — | Filter by channel |
| limit | number | — | Max results (default 20) |
| order | string | — | Sort order |
| search | string | — | Search by campaign name |
| sort | string | — | Sort column |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_categories ~13
List CMS post categories.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_contacts ~62
List contacts (people linked to CRM accounts), optionally filtered by account or search.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | — | Filter by account |
| limit | number | — | Max results (default 20) |
| search | string | — | Match name, email, or phone |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_conversations ~95
List messaging conversations across WhatsApp, Messenger, Instagram, Threads, SMS, email, and other enabled channels. Threads items are public conversations. Shows unread counts and last message time.
| Name | Type | Req | Description |
|---|---|---|---|
| channel | string | — | Filter by channel |
| limit | number | — | Max results (default 20) |
| search | string | — | Search by contact name, phone, or email |
| status | string | — | Filter by conversation status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_custom_fields ~42
List custom field definitions for CRM entities such as account, contact, deal, or booking.
| Name | Type | Req | Description |
|---|---|---|---|
| entityType | string | yes | Entity type the custom fields belong to |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_deals ~92
List CRM deals (sales pipeline) with optional filters.
| Name | Type | Req | Description |
|---|---|---|---|
| accountId | string | — | Filter by account |
| dealType | string | — | Filter by deal type |
| limit | number | — | Items per page (default 20) |
| page | number | — | Page number (default 1) |
| search | string | — | Search by name or description |
| stage | string | — | Filter by stage |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_image_models ~41
List AI image-generation models exposed to merchants (sanitized — provider/cost details hidden). Use to pick a `modelCode` for `generate_post_cover`.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_invoices ~91
List invoices with optional filters. Use status "OVERDUE" to find unpaid invoices past due date.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| order | string | — | Sort order |
| search | string | — | Search by invoice number, account name, email, or phone |
| sort | string | — | Sort column |
| status | string | — | Filter by invoice status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_knowledge_documents ~112
List merchant knowledge base documents (uploads + scraped URLs). Use reviewStatus/syncable to see what is ready for agent retrieval. Pass `updatedAfter` for delta sync. Reviewed content is fetched via GET /v6/merchant/ai/knowledge/{id}/content; source audit text is available with ?variant=extracted.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 100) |
| updatedAfter | string | — | ISO timestamp — only return docs updated after this. Use for delta sync. |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_my_companies ~33
List all companies/organisations the current user has access to. Use this to see available orgs before switching.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_notes ~60
List notes attached to a member/account, booking, or ticket.
| Name | Type | Req | Description |
|---|---|---|---|
| entityId | string | yes | The entity ID |
| entityType | string | yes | Type of entity the notes are on |
| limit | number | — | Max results (default 10) |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_notification_logs ~123
List notification delivery logs for the current company. Recipients are masked by default for incident-response safety.
| Name | Type | Req | Description |
|---|---|---|---|
| channel | string | — | Notification channel filter |
| dateFrom | string | — | ISO timestamp lower bound |
| dateTo | string | — | ISO timestamp upper bound |
| entityId | string | — | Entity ID filter |
| eventType | string | — | Event type filter |
| limit | number | — | Max results (default 50, max 100) |
| recipient | string | — | Substring search on recipient |
| status | string | — | Status filter |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_offer_rules ~56
List upsell/cross-sell offer rules with optional filters.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| status | string | — | Filter by status |
| type | string | — | Filter by rule type |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_orders ~57
List shop orders with optional status and search filters.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| search | string | — | Search by order number or customer name/email |
| status | string | — | Filter by order status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_outlets ~36
List shop outlets/locations for the company.
| Name | Type | Req | Description |
|---|---|---|---|
| activeOnly | boolean | — | When true, only return active outlets (default false) |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_plan_options ~30
List active FavCRM plans with prices, quotas, included modules, and whether each is the current plan.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_post_type_fields ~56
List the custom field schema for a post type. Use this before creating posts to know which keys to pass in meta and what types they expect.
| Name | Type | Req | Description |
|---|---|---|---|
| postTypeId | string | yes | Post type ID (from list_post_types) |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_post_types ~31
List all post types defined for this company (built-in: blog_post, page; plus any custom types).
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_posts ~82
List CMS posts (blog posts and/or pages) with optional filters.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| search | string | — | Search by title |
| status | string | — | Filter by status |
| type | string | — | Filter by post type slug (blog_post, page, or any custom type — see list_post_types). |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_product_categories ~17
List all product categories for the shop.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_products ~68
List shop products with optional filters by name, status, or category.
| Name | Type | Req | Description |
|---|---|---|---|
| categoryId | number | — | Filter by category ID |
| limit | number | — | Max results (default 20) |
| search | string | — | Search by product name |
| status | string | — | Filter by status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_promotions ~52
List promotion/coupon codes with optional status filter.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| search | string | — | Search by name |
| status | string | — | Filter by status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_resources ~31
List booking resources (rooms, equipment, etc.).
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_reward_schemes ~49
List loyalty reward schemes (points/stamps programs) configured for this business.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| search | string | — | Search by name |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_segments ~46
List customer segments. Segments group members by criteria for targeted campaigns.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| search | string | — | Search by segment name |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_service_categories ~25
List service categories (groups for booking services like "Treatments", "Classes").
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_service_packages ~87
List service packages/prepaid session bundles with optional search, status, sorting, and pagination.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| order | string | — | Sort order |
| search | string | — | Search package name |
| sort | string | — | Sort column: name, price, or createdAt |
| status | string | — | Filter by package status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_service_schedules ~100
List schedule windows for booking services.
| Name | Type | Req | Description |
|---|---|---|---|
| dateFrom | string | — | YYYY-MM-DD |
| dateTo | string | — | YYYY-MM-DD |
| isOverride | boolean | — | Filter to override entries only |
| limit | number | — | Max results (default 20) |
| resourceId | string | — | Resource ID (room/equipment) |
| serviceId | string | — | Service ID |
| staffId | string | — | Staff member ID |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_services ~54
List booking services with name, price, duration, and status.
| Name | Type | Req | Description |
|---|---|---|---|
| limit | number | — | Max results (default 20) |
| search | string | — | Search by name |
| status | string | — | Filter by status |
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.
list_shipping_methods ~18
List all shipping methods configured for the shop.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| data | — | yes | Tool result payload — shape varies per tool, see the tool description |
| renderType | string | yes | UI rendering hint for the result |
| summary | string | yes | One-line human-readable summary of the action |
No examples provided.