Servidor MCP

FirmLedger

ke.co.firmledger/firmledger

Qué hace este MCP

Searches and manages verified business directory listings, company profiles, leads, jobs, watchlists, analytics, advertising, and account integrations.

check_domain
Check whether a website is listed (Pro)
FirmLedger Pro. Given a website domain or URL, report whether an approved FirmLedger record uses it and return that record — useful for "is this site legit?" questions.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'maxLength': 200, 'minLength': 3, 'description': 'A domain such as "example.co.ke" or a full URL.'}}, 'additionalProperties': False}
compare_listings
Compare FirmLedger listings side by side
Compare 2 to 4 approved FirmLedger companies side by side: entity type, category, location, founded, team size, website, tagline, date registered, ownership, tick, confidence and sponsored status — the same rows as the FirmLedger comparison page. Use after search_listings when the user wants to weigh companies against each other.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listings'], 'properties': {'listings': {'type': 'array', 'items': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}, 'maxItems': 4, 'minItems': 2, 'description': '2 to 4 companies (slugs are best).'}}, 'additionalProperties': False}
connection_status
Check FirmLedger connection access
Report what this FirmLedger connection can do: Free or Pro access, authentication and active free-trial status, and which tools and fields are available. Use when the user asks why something is locked.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
create_support_ticket
Open a support ticket
Open a FirmLedger support ticket for the user. Categories: billing, technical, listing, account, verification, other. Requires the user's confirmation of the exact subject and message.
Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['subject', 'category', 'body'], 'properties': {'body': {'type': 'string', 'maxLength': 5000, 'minLength': 20, 'description': 'The issue in a few sentences.'}, 'subject': {'type': 'string', 'maxLength': 200, 'minLength': 4}, 'category': {'enum': ['billing', 'technical', 'listing', 'account', 'verification', 'other'], 'type': 'string'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
create_webhook
Create a webhook destination
Register a webhook on the user’s account after explicit confirmation. Listing events will be sent to this URL. Requires Pro (including a free trial) and write:account. The signing secret is returned only once; keep it private.
Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['url', 'events'], 'properties': {'url': {'type': 'string', 'maxLength': 500, 'description': 'Public HTTPS destination for signed events.'}, 'label': {'type': 'string', 'maxLength': 80}, 'events': {'type': 'array', 'items': {'enum': ['listing.approved', 'listing.rejected', 'listing.updated', 'listing.created', 'listing.deleted', 'claim.verified'], 'type': 'string'}, 'maxItems': 6, 'minItems': 1}, 'categories': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80}, 'maxItems': 50}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
export_watchlist_csv
Export my watchlist as CSV
The user's watchlist as CSV text (name, category, type, location, contact details, tech stack, verified owner, confidence, watched since) — the same file as the dashboard's Export button.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
get_analytics
Read my audience analytics
Audience analytics for the user's own listings — views today/7/30 days/total, unique visitors, profile and website clicks, leads, the 30-day funnel, top visitor locations and per-listing views. The same numbers as Dashboard → Audience analytics.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': "Optional: one of the user's listings. Omit for all of them combined."}}, 'additionalProperties': False}
get_api_status
REST API v1 status for this key
The state of the FirmLedger REST API for this account and API key, as /api/v1/me and /api/v1/usage answer it: identity, plan and free-trial status, the key's scopes, live per-minute read/write budgets, durable usage aggregates and the endpoint catalogue. Also states plainly that the MCP connector and REST API v1 are the same platform API — one account, one key, one Pro entitlement — and exactly what happens to API and MCP access when a free trial ends.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'key_prefix': {'type': 'string', 'maxLength': 40, 'description': 'Optional: focus on one key by its prefix.'}}, 'additionalProperties': False}
get_lead
Read one lead conversation
One conversation from the Leads inbox with the inquirer's details and every message, oldest first. Use before reply_to_lead so the reply fits the thread.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['lead_id'], 'properties': {'lead_id': {'type': 'integer', 'minimum': 1, 'description': 'lead_id from list_leads.'}}, 'additionalProperties': False}
get_listing
Get a FirmLedger company profile
The public FirmLedger profile of one company: description, category, location, verification state (tick, how ownership was proved, when it was last checked), confidence and health scores, sources, recent moderated news headlines and the open jobs count. With FirmLedger Pro it also includes website, email, phone, social links, key people, timeline and technology — the same line the website draws.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}}, 'additionalProperties': False}
get_my_listings
List my FirmLedger listings
The listings this account owns or submitted, with moderation status, tick, scores, Pro perks, sponsorship, jobs and new-lead counts. Use first when the user refers to "my listing".
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
get_news
Get moderated company news (Pro)
FirmLedger Pro. Recent moderated news headlines about one company with dates, publishers and links — the same accuracy-gated stories shown on the profile's news panel.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'limit': {'anyOf': [{'type': 'integer'}, {'type': 'string', 'pattern': '^-?[0-9]+$'}], 'default': 10, 'description': 'Stories to return (1-12).. Integer or numeric string, clamped to 1–12.'}, 'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}}, 'additionalProperties': False}
get_notifications
Read my notifications
The user's in-app FirmLedger notifications, newest first, with the unread count. Set unread_only for just the unread ones.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 20, 'maximum': 60, 'minimum': 1}, 'unread_only': {'type': 'boolean', 'default': False}}, 'additionalProperties': False}
get_relationships
Get a company's relationship graph (Pro)
FirmLedger Pro. The recorded relationship graph of one company: founders, investors, parent companies, subsidiaries, products, services and partners — plus the reverse edges (companies it founded or invested in). Only relationships recorded by the verified owner or moderators; nothing is inferred.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}}, 'additionalProperties': False}
get_watchlist
Read my watchlist
The companies the user watches on FirmLedger, newest first.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_ad_packages
List FirmLedger advertising packages
The current Sponsored-placement advertising packages with price, billing and duration. With an API key it also lists the user's own listings and which of them can be advertised or are already sponsored. Use before prepare_advertising.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_api_keys
List my API keys
The account's API keys with label, prefix, scopes, usage totals and last use — never a raw key. Use it to name a key before revoking or re-scoping it.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_categories
List FirmLedger categories
Every FirmLedger category with its number of approved listings. Use to pick a valid category for search_listings.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_countries
List countries on FirmLedger
The countries present in the FirmLedger directory, each with its number of approved listings.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_jobs
List open jobs (Pro)
FirmLedger Pro. Open roles at approved FirmLedger companies, filtered by company and/or location and keyword: title, company, location, posted date and where to apply. Jobs on unapproved listings never appear.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'anyOf': [{'type': 'integer'}, {'type': 'string', 'pattern': '^-?[0-9]+$'}], 'default': 10, 'description': 'limit. Integer or numeric string, clamped to 1–25.'}, 'query': {'type': 'string', 'maxLength': 80, 'description': 'Optional keyword in the job title or description.'}, 'offset': {'anyOf': [{'type': 'integer'}, {'type': 'string', 'pattern': '^-?[0-9]+$'}], 'default': 0, 'description': 'offset. Integer or numeric string, clamped to 0–10000.'}, 'company': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'Optional company (slug, exact name, FirmLedger ID or profile URL).'}, 'location': {'type': 'string', 'maxLength': 80, 'description': 'Optional location, e.g. "Nairobi" or "Kenya" or "Remote".'}}, 'additionalProperties': False}
list_leads
List my leads
The user's FirmLedger Leads inbox: inquiries received on their listings (box "received", the default), archived ones ("archived"), or inquiries they sent to other businesses ("sent"). Filter by status or listing; paginated.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'box': {'enum': ['received', 'archived', 'sent'], 'type': 'string'}, 'page': {'type': 'integer', 'default': 1, 'minimum': 1}, 'limit': {'type': 'integer', 'default': 20, 'maximum': 50, 'minimum': 1}, 'status': {'enum': ['new', 'contacted', 'qualified', 'won', 'lost'], 'type': 'string'}, 'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': "Optional: only leads for this listing of the user's."}}, 'additionalProperties': False}
list_my_tickets
Read my support tickets
The user's FirmLedger support tickets. Pass a ticket reference to read that ticket's full conversation.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'ticket': {'type': 'string', 'maxLength': 40, 'description': 'Optional ticket reference, e.g. "TK-1A2B3C".'}}, 'additionalProperties': False}
list_plans
List FirmLedger Pro plans
The current FirmLedger Pro offers with price, billing and duration. With an API key it also says whether this account is already on Pro and whether a free trial is available. Use before prepare_upgrade.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {}, 'additionalProperties': False}
list_webhooks
List my webhook destinations
The account's webhook destinations with events, category filters, active state and signing-secret prefix — plus recent deliveries (status, HTTP code, attempts, last error) when a webhook id is given.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'limit': {'type': 'integer', 'default': 10, 'maximum': 25, 'minimum': 1}, 'webhook_id': {'type': 'integer', 'minimum': 1, 'description': 'Optional: one destination, with its recent deliveries.'}}, 'additionalProperties': False}
manage_api_keys
Manage my API keys
Create an API key (the raw key is returned once), revoke a key, or change a key's scopes — the dashboard's Developer API controls. Requires the user's confirmation. Keys can also carry the AI-assistant scopes (read:account / write:account) that this connector uses.
Destructivo Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['action'], 'properties': {'label': {'type': 'string', 'maxLength': 60, 'description': 'create: a name for the key.'}, 'action': {'enum': ['create', 'revoke', 'update_scopes'], 'type': 'string'}, 'key_id': {'type': 'integer', 'minimum': 1, 'description': 'revoke/update_scopes: the key id from list_api_keys.'}, 'scopes': {'type': 'array', 'items': {'enum': ['read:listings', 'write:listings', 'export', 'manage:webhooks', 'read:usage', 'read:account', 'write:account'], 'type': 'string'}, 'maxItems': 9, 'minItems': 1, 'description': 'Scope ids. Required for update_scopes; create defaults to the standard scopes.', 'uniqueItems': True}, 'key_prefix': {'type': 'string', 'maxLength': 40, 'description': 'Optional alternative to key_id.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
manage_job
Edit, close or remove my job
Manage a job owned by the member: edit its title, type, location, apply link or description, close it, or permanently remove it. Editing a live or closed role returns it to moderation before it is public again. Requires the user’s confirmation.
Destructivo
Esquema de entrada
{'type': 'object', 'required': ['action', 'job_id'], 'properties': {'title': {'type': 'string', 'maxLength': 80}, 'action': {'enum': ['edit', 'close', 'remove', 'delete'], 'type': 'string'}, 'job_id': {'type': 'integer', 'minimum': 1}, 'location': {'type': 'string', 'maxLength': 80}, 'apply_url': {'type': 'string', 'maxLength': 400}, 'role_type': {'enum': ['Full-time', 'Part-time', 'Contract', 'Internship', 'Remote'], 'type': 'string'}, 'description': {'type': 'string', 'maxLength': 600}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
manage_lead
Archive, restore or delete a lead conversation
Archive a conversation out of the business inbox, restore it, or delete it permanently — the dashboard's conversation controls. Requires the user's confirmation (deleting is irreversible).
Destructivo
Esquema de entrada
{'type': 'object', 'required': ['action', 'lead_id'], 'properties': {'action': {'enum': ['archive', 'unarchive', 'delete'], 'type': 'string'}, 'lead_id': {'type': 'integer', 'minimum': 1, 'description': 'The lead id from list_leads.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
manage_webhooks
Manage my webhook destinations
Create, update, pause, resume, rotate the signing secret of, test, retry a delivery for, or delete a webhook destination on the user's account — the same operations as Dashboard → Developer API. Secrets come back only for create and rotate. Requires the user's confirmation.
Destructivo Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['action'], 'properties': {'url': {'type': 'string', 'maxLength': 500, 'description': 'create/update: the receiver URL (https in production).'}, 'label': {'type': 'string', 'maxLength': 80}, 'action': {'enum': ['create', 'update', 'pause', 'resume', 'rotate_secret', 'test', 'retry_delivery', 'delete'], 'type': 'string'}, 'events': {'type': 'array', 'items': {'type': 'string'}, 'maxItems': 6, 'description': 'create/update: event types to subscribe to.'}, 'categories': {'type': 'array', 'items': {'type': 'string', 'maxLength': 80}, 'maxItems': 50}, 'webhook_id': {'type': 'integer', 'minimum': 1, 'description': 'Required for every action except create.'}, 'delivery_id': {'type': 'integer', 'minimum': 1, 'description': 'retry_delivery: which delivery to retry.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
mark_notifications_read
Mark notifications as read
Mark one notification (notification_id) or all of them (all: true) as read. Requires the user's confirmation.
Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'all': {'type': 'boolean'}, 'notification_id': {'type': 'integer', 'minimum': 1}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
post_job
Post a job on my listing
Submit a job opening on one of the user's listings (the listing needs active Pro perks; up to 5 open or pending roles). Like the dashboard form, it goes to moderation first and is published after approval. Requires the user's confirmation.
Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['listing', 'title', 'location', 'apply_url', 'description'], 'properties': {'title': {'type': 'string', 'maxLength': 80, 'minLength': 3}, 'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': "One of the user's own listings."}, 'location': {'type': 'string', 'maxLength': 80, 'minLength': 1, 'description': 'City, or "Remote".'}, 'apply_url': {'type': 'string', 'maxLength': 400, 'description': 'Full https:// link to the job post or careers page.'}, 'role_type': {'enum': ['Full-time', 'Part-time', 'Contract', 'Internship', 'Remote'], 'type': 'string'}, 'description': {'type': 'string', 'maxLength': 600, 'minLength': 30}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
prepare_advertising
Prepare a FirmLedger advertising checkout link
Does NOT charge anything. Checks that the listing belongs to this account and is approved, then returns a personal link to FirmLedger's own checkout for the chosen Sponsored-placement package. The user reviews and pays there themselves; you can never complete or confirm a payment. If the user says "yes, do it", give them the link again.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing', 'package'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': "One of the user's own approved listings (see get_my_listings or list_ad_packages)."}, 'package': {'type': 'string', 'maxLength': 120, 'description': 'The package id from list_ad_packages (or its exact name).'}}, 'additionalProperties': False}
prepare_listing_claim
Prepare a listing ownership claim
Free. Prepare a link to claim an approved listing using DNS TXT, HTML meta tag or site badge. Creates nothing and never grants ownership. The user signs in, generates a token, installs the proof on the business domain and verifies it on FirmLedger.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'method': {'enum': ['dns', 'meta', 'badge'], 'type': 'string'}, 'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}}, 'additionalProperties': False}
prepare_listing_submission
Prepare a FirmLedger listing submission link
Does NOT create anything. Returns a link to the real FirmLedger submission form with the company name, website and (optional) category, country and city pre-filled. The user opens it, signs in, completes the remaining fields, reviews everything and submits it themselves. Also reports if the company is already listed, so nothing is submitted twice.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'required': ['name'], 'properties': {'city': {'type': 'string', 'maxLength': 80, 'description': 'Optional city.'}, 'name': {'type': 'string', 'maxLength': 120, 'minLength': 2, 'description': 'Company name.'}, 'country': {'type': 'string', 'maxLength': 60, 'description': 'Optional country.'}, 'website': {'type': 'string', 'maxLength': 200, 'description': 'Company website, e.g. "example.co.ke".'}, 'category': {'type': 'string', 'maxLength': 60, 'description': 'Optional category.'}}, 'additionalProperties': False}
prepare_upgrade
Prepare a FirmLedger Pro checkout link
Does NOT charge anything. Returns a personal link to FirmLedger's own checkout for the chosen Pro plan (optionally with a promo code). The user opens it, signs in, reviews the order on FirmLedger and pays on the secure Lemon Squeezy checkout themselves. You can never complete or confirm a payment and must never ask for card details; if the user says "yes, do it", give them the link again. Without an API key it returns the pricing page instead.
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'plan': {'type': 'string', 'maxLength': 120, 'description': 'The plan id from list_plans (or its exact name).'}, 'promo_code': {'type': 'string', 'maxLength': 40, 'description': 'Optional promo code the user gave you.'}}, 'additionalProperties': False}
refresh_listing_news
Refresh my listing's news
Look for new coverage of one of the user's approved listings with the same accuracy rules and moderation as the dashboard's "Refresh news" (once a minute per listing). Requires the user's confirmation.
Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': "One of the user's own approved listings."}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
refresh_listing_scores
Refresh my listing's scores
Recompute the confidence, health and completeness scores of one of the user's listings from its current record — the dashboard's "Re-align scores". Requires the user's confirmation.
Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': "One of the user's own listings."}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
refresh_listing_tech
Refresh my listing's technology snapshot
Scan the website of one of the user's listings and refresh its technology snapshot — the dashboard's "Refresh tech". Requires the user's confirmation.
Acceso externo Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': "One of the user's own listings."}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
reply_to_lead
Reply to a lead
Send a reply in one of the user's lead conversations, exactly as the Reply box on the website does (the other party is notified). Requires the user's confirmation: the first call returns the exact message for them to approve.
Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['lead_id', 'message'], 'properties': {'lead_id': {'type': 'integer', 'minimum': 1}, 'message': {'type': 'string', 'maxLength': 4000, 'minLength': 2, 'description': 'The reply text, written or approved by the user.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
reply_to_ticket
Reply to an open support ticket
Send a reply in one of the user's own support tickets — the same thread the dashboard shows, and the same message an agent answers. Closed tickets cannot take replies. Requires the user's confirmation of the exact text.
Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['ticket', 'message'], 'properties': {'ticket': {'type': 'string', 'maxLength': 40, 'minLength': 1, 'description': 'The ticket reference (e.g. TK-1A2B3C) or its id, from list_my_tickets.'}, 'message': {'type': 'string', 'maxLength': 4000, 'minLength': 2, 'description': 'The reply text, written or approved by the user.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
request_listing_removal
Request removal of my listing
Send a removal request for a listing the user owns or originally submitted. A moderator reviews it; nothing is removed until they accept. Requires the user's confirmation.
Destructivo
Esquema de entrada
{'type': 'object', 'required': ['listing', 'reason'], 'properties': {'reason': {'type': 'string', 'maxLength': 2000, 'minLength': 20, 'description': 'Why it should be removed (20+ characters).'}, 'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'A listing the user owns or submitted.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
search_listings
Search FirmLedger listings
Search approved FirmLedger company records by name or keyword, category, country, city and verified status. Returns a short list (name, category, location, verified flag, tick, confidence score, one-line description) plus the accurate total, for picking the right company before calling get_listing. Use city for places like "Nairobi" and country for "Kenya".
Solo lectura Idempotente
Esquema de entrada
{'type': 'object', 'properties': {'city': {'type': 'string', 'maxLength': 80, 'description': 'City or region, e.g. "Nairobi".'}, 'type': {'enum': ['company', 'startup', 'agency', 'organization', 'product', 'service', 'publisher'], 'type': 'string', 'description': 'Entity type.'}, 'limit': {'anyOf': [{'type': 'integer'}, {'type': 'string', 'pattern': '^-?[0-9]+$'}], 'default': 10, 'description': 'Results per page (1-25).. Integer or numeric string, clamped to 1–25.'}, 'query': {'type': 'string', 'maxLength': 100, 'description': 'Company name or keyword (matched against name, tagline, description, tags and city).'}, 'offset': {'anyOf': [{'type': 'integer'}, {'type': 'string', 'pattern': '^-?[0-9]+$'}], 'default': 0, 'description': 'Results to skip, for paging (use next_offset).. Integer or numeric string, clamped to 0–10000.'}, 'country': {'type': 'string', 'maxLength': 60, 'description': 'Country name, e.g. "Kenya".'}, 'category': {'type': 'string', 'maxLength': 60, 'description': 'Category name, e.g. "Fintech". Call list_categories for valid names.'}, 'verified_only': {'anyOf': [{'type': 'boolean'}, {'enum': ['true', 'false'], 'type': 'string'}], 'description': 'Only ownership-verified records (boolean or the string true/false).'}}, 'additionalProperties': False}
set_lead_status
Change a lead's status
Move a lead in the user's business inbox to new, contacted, qualified, won or lost. Requires the user's confirmation.
Destructivo Idempotente
Esquema de entrada
{'type': 'object', 'required': ['lead_id', 'status'], 'properties': {'status': {'enum': ['new', 'contacted', 'qualified', 'won', 'lost'], 'type': 'string'}, 'lead_id': {'type': 'integer', 'minimum': 1}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
start_lead
Contact a claimed business
Start a new FirmLedger Leads conversation with another approved, claimed business. The signed-in member email is used automatically, the business email stays private, and the owner is notified in their Leads inbox. Requires the user’s confirmation of the exact inquiry.
Acceso externo
Esquema de entrada
{'type': 'object', 'required': ['listing', 'message'], 'properties': {'name': {'type': 'string', 'maxLength': 120, 'description': 'Optional sender name; defaults to the member profile name.'}, 'phone': {'type': 'string', 'maxLength': 40}, 'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}, 'message': {'type': 'string', 'maxLength': 4000, 'minLength': 10}, 'looking_for': {'type': 'string', 'maxLength': 140, 'description': 'Optional short subject or what the member needs.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
update_my_listing
Edit one of my listings
Change fields on a listing the user owns (name, tagline, description, website, email, phone, country, city, region, address, logo_url, founded, size, tags, socials) — the same service the dashboard edit form and PUT /api/v1/my/listings/:id use, including the re-moderation rule when the core record changes. Requires the user's confirmation.
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'city': {'type': 'string', 'maxLength': 80}, 'name': {'type': 'string', 'maxLength': 120}, 'size': {'type': 'string', 'maxLength': 40}, 'tags': {'type': 'string', 'maxLength': 300}, 'email': {'type': 'string', 'maxLength': 190}, 'phone': {'type': 'string', 'maxLength': 40}, 'region': {'type': 'string', 'maxLength': 80}, 'address': {'type': 'string', 'maxLength': 200}, 'country': {'type': 'string', 'maxLength': 80}, 'founded': {'type': 'string', 'maxLength': 12}, 'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}, 'socials': {'anyOf': [{'type': 'object', 'properties': {'x': {'type': 'string', 'maxLength': 500}, 'youtube': {'type': 'string', 'maxLength': 500}, 'facebook': {'type': 'string', 'maxLength': 500}, 'linkedin': {'type': 'string', 'maxLength': 500}, 'instagram': {'type': 'string', 'maxLength': 500}}, 'additionalProperties': False}, {'type': 'string', 'maxLength': 800}], 'description': 'Social profile links keyed by network; use an empty object to clear. A JSON object string is also accepted.'}, 'tagline': {'type': 'string', 'maxLength': 160}, 'website': {'type': 'string', 'maxLength': 300}, 'logo_url': {'type': 'string', 'maxLength': 500}, 'description': {'type': 'string', 'maxLength': 4000}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
watchlist_add
Add a company to my watchlist
Add an approved company to the user's watchlist so they are notified when its record changes. Requires the user's confirmation.
Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
watchlist_remove
Remove a company from my watchlist
Remove a company from the user's watchlist. Requires the user's confirmation.
Destructivo Idempotente
Esquema de entrada
{'type': 'object', 'required': ['listing'], 'properties': {'listing': {'type': 'string', 'maxLength': 300, 'minLength': 1, 'description': 'The company: its FirmLedger slug (best — returned by search_listings), its exact name, its FirmLedger ID such as "FL-00012", or its FirmLedger profile URL.'}, 'confirmation_token': {'type': 'string', 'maxLength': 2048, 'description': 'Leave empty on the first call: you get an action_summary and a token instead of the action. After the user explicitly confirms that summary, call again with the SAME arguments plus this token.'}}, 'additionalProperties': False}
Añadido
connection_status
29 de September de 2026 a las 02:40
Añadido
manage_lead
29 de September de 2026 a las 02:40
Añadido
update_my_listing
29 de September de 2026 a las 02:40
Añadido
manage_api_keys
29 de September de 2026 a las 02:40
Añadido
manage_webhooks
29 de September de 2026 a las 02:40
Añadido
reply_to_ticket
29 de September de 2026 a las 02:40
Añadido
create_webhook
29 de September de 2026 a las 02:40
Añadido
prepare_listing_claim
29 de September de 2026 a las 02:40
Añadido
request_listing_removal
29 de September de 2026 a las 02:40
Añadido
refresh_listing_news
29 de September de 2026 a las 02:40
Añadido
refresh_listing_tech
29 de September de 2026 a las 02:40
Añadido
refresh_listing_scores
29 de September de 2026 a las 02:40
Añadido
mark_notifications_read
29 de September de 2026 a las 02:40
Añadido
post_job
29 de September de 2026 a las 02:40
Añadido
manage_job
29 de September de 2026 a las 02:40
Añadido
create_support_ticket
29 de September de 2026 a las 02:40
Añadido
watchlist_remove
29 de September de 2026 a las 02:40
Añadido
watchlist_add
29 de September de 2026 a las 02:40
Añadido
set_lead_status
29 de September de 2026 a las 02:40
Añadido
reply_to_lead
29 de September de 2026 a las 02:40
Añadido
start_lead
29 de September de 2026 a las 02:40
Añadido
list_api_keys
29 de September de 2026 a las 02:40
Añadido
list_webhooks
29 de September de 2026 a las 02:40
Añadido
get_api_status
29 de September de 2026 a las 02:40
Añadido
list_my_tickets
29 de September de 2026 a las 02:40
Añadido
get_notifications
29 de September de 2026 a las 02:40
Añadido
export_watchlist_csv
29 de September de 2026 a las 02:40
Añadido
get_watchlist
29 de September de 2026 a las 02:40
Añadido
get_lead
29 de September de 2026 a las 02:40
Añadido
list_leads
29 de September de 2026 a las 02:40