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".
输入参数citytypelimitqueryoffsetcountrycategoryverified_only
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.
输入参数listing必填
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.
输入参数listing必填
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.
输入参数limitlisting必填
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.
输入参数limitqueryoffsetcompanylocation
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.
输入参数domain必填
list_categories
List FirmLedger categories
Every FirmLedger category with its number of approved listings. Use to pick a valid category for search_listings.
无需输入参数。
list_countries
List countries on FirmLedger
The countries present in the FirmLedger directory, each with its number of approved listings.
无需输入参数。
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.
输入参数cityname必填countrywebsitecategory
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.
输入参数listings必填
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.
无需输入参数。
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.
无需输入参数。
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.
输入参数planpromo_code
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.
输入参数listing必填package必填
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".
无需输入参数。
get_analytics
Read my audience analytics
Audience analytics for the user's own listings — views today/7/30 days/total, distinct hashed visitor signals, profile and website clicks, leads, the 30-day funnel (placements served and browser-measured viewable impressions are separate), top locations and per-listing views. The same numbers as Dashboard → Audience analytics.
输入参数listing
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.
输入参数boxpagelimitstatuslisting
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.
输入参数lead_id必填
get_watchlist
Read my watchlist
The companies the user watches on FirmLedger, newest first.
无需输入参数。
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.
无需输入参数。
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.
输入参数limitunread_only
list_my_tickets
Read my support tickets
The user's FirmLedger support tickets. Pass a ticket reference to read that ticket's full conversation.
输入参数ticket
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.
输入参数key_prefix
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.
输入参数limitwebhook_id
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.
无需输入参数。
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.
输入参数namephonelisting必填message必填looking_forconfirmation_token
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.
输入参数lead_id必填message必填confirmation_token
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.
输入参数status必填lead_id必填confirmation_token
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.
输入参数listing必填confirmation_token
watchlist_remove
Remove a company from my watchlist
Remove a company from the user's watchlist. Requires the user's confirmation.
输入参数listing必填confirmation_token
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.
输入参数body必填subject必填category必填confirmation_token
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.
输入参数titleaction必填job_id必填locationapply_urlrole_typedescriptionconfirmation_token
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.
输入参数title必填listing必填location必填apply_url必填role_typedescription必填confirmation_token
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.
输入参数allnotification_idconfirmation_token
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.
输入参数listing必填confirmation_token
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.
输入参数listing必填confirmation_token
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.
输入参数listing必填confirmation_token
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.
输入参数reason必填listing必填confirmation_token
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.
输入参数methodlisting必填
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.
输入参数url必填labelevents必填categoriesconfirmation_token
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.
输入参数ticket必填message必填confirmation_token
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.
输入参数urllabelaction必填eventscategorieswebhook_iddelivery_idconfirmation_token
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.
输入参数labelaction必填key_idscopeskey_prefixconfirmation_token
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.
输入参数citynamesizetagsemailphoneregionaddresscountryfoundedlisting必填socials另有 5 个
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).
输入参数action必填lead_id必填confirmation_token
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.
无需输入参数。
get_connection_status
Get FirmLedger connection status
Report how this assistant is connected to FirmLedger: public (no sign-in), an API key, or the member's account through sign-in (OAuth). Shows Free or Pro, the trial status, which tools and fields are available, and whether the sign-in token is about to expire. Use it when the member asks whether they are connected or signed in, or why something is locked.
无需输入参数。
request_authentication
Connect or renew the FirmLedger account
Connect this assistant to the member's own FirmLedger account by sign-in (OAuth), or renew or replace that connection. Call it when the member says "connect me to my account", "sign me in", or asks to switch accounts. The assistant opens FirmLedger in the browser, the member approves there, and no password or key passes through the chat. mode "connect" (the default) starts sign-in when the connection needs it. mode "reauthenticate" ends the current connection so the member can choose the account again. mode "refresh" renews a sign-in token that is about to expire, and the assistant should then retry.
输入参数mode
revoke_connection
Remove the FirmLedger account connection
Disconnect this assistant from the member's FirmLedger account. The sign-in is revoked on FirmLedger's side at once, and every token it issued stops working. Call it when the member asks to remove, sign out or disconnect their account. It cannot erase the token stored in the member's assistant app, so tell the member to remove the FirmLedger connector there as well.
无需输入参数。