FirmLedger

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".

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 100,
      "description": "Company name or keyword (matched against name, tagline, description, tags and city)."
    },
    "category": {
      "type": "string",
      "maxLength": 60,
      "description": "Category name, e.g. \"Fintech\". Call list_categories for valid names."
    },
    "country": {
      "type": "string",
      "maxLength": 60,
      "description": "Country name, e.g. \"Kenya\"."
    },
    "city": {
      "type": "string",
      "maxLength": 80,
      "description": "City or region, e.g. \"Nairobi\"."
    },
    "type": {
      "type": "string",
      "enum": [
        "company",
        "startup",
        "agency",
        "organization",
        "product",
        "service",
        "publisher"
      ],
      "description": "Entity type."
    },
    "verified_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string",
          "enum": [
            "true",
            "false"
          ]
        }
      ],
      "description": "Only ownership-verified records (boolean or the string true/false)."
    },
    "limit": {
      "default": 10,
      "description": "Results per page (1-25).. Integer or numeric string, clamped to 1–25.",
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string",
          "pattern": "^-?[0-9]+$"
        }
      ]
    },
    "offset": {
      "default": 0,
      "description": "Results to skip, for paging (use next_offset).. Integer or numeric string, clamped to 0–10000.",
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string",
          "pattern": "^-?[0-9]+$"
        }
      ]
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    },
    "limit": {
      "default": 10,
      "description": "Stories to return (1-12).. Integer or numeric string, clamped to 1–12.",
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string",
          "pattern": "^-?[0-9]+$"
        }
      ]
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "company": {
      "type": "string",
      "description": "Optional company (slug, exact name, FirmLedger ID or profile URL).",
      "minLength": 1,
      "maxLength": 300
    },
    "location": {
      "type": "string",
      "maxLength": 80,
      "description": "Optional location, e.g. \"Nairobi\" or \"Kenya\" or \"Remote\"."
    },
    "query": {
      "type": "string",
      "maxLength": 80,
      "description": "Optional keyword in the job title or description."
    },
    "limit": {
      "default": 10,
      "description": "limit. Integer or numeric string, clamped to 1–25.",
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string",
          "pattern": "^-?[0-9]+$"
        }
      ]
    },
    "offset": {
      "default": 0,
      "description": "offset. Integer or numeric string, clamped to 0–10000.",
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string",
          "pattern": "^-?[0-9]+$"
        }
      ]
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "minLength": 3,
      "maxLength": 200,
      "description": "A domain such as \"example.co.ke\" or a full URL."
    }
  },
  "required": [
    "domain"
  ],
  "additionalProperties": false
}

Every FirmLedger category with its number of approved listings. Use to pick a valid category for search_listings.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

The countries present in the FirmLedger directory, each with its number of approved listings.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 120,
      "description": "Company name."
    },
    "website": {
      "type": "string",
      "maxLength": 200,
      "description": "Company website, e.g. \"example.co.ke\"."
    },
    "category": {
      "type": "string",
      "maxLength": 60,
      "description": "Optional category."
    },
    "country": {
      "type": "string",
      "maxLength": 60,
      "description": "Optional country."
    },
    "city": {
      "type": "string",
      "maxLength": 80,
      "description": "Optional city."
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listings": {
      "type": "array",
      "minItems": 2,
      "maxItems": 4,
      "items": {
        "type": "string",
        "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.",
        "minLength": 1,
        "maxLength": 300
      },
      "description": "2 to 4 companies (slugs are best)."
    }
  },
  "required": [
    "listings"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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.

{
  "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
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "description": "One of the user's own approved listings (see get_my_listings or list_ad_packages).",
      "minLength": 1,
      "maxLength": 300
    },
    "package": {
      "type": "string",
      "maxLength": 120,
      "description": "The package id from list_ad_packages (or its exact name)."
    }
  },
  "required": [
    "listing",
    "package"
  ],
  "additionalProperties": false
}

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".

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "description": "Optional: one of the user's listings. Omit for all of them combined.",
      "minLength": 1,
      "maxLength": 300
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "box": {
      "type": "string",
      "enum": [
        "received",
        "archived",
        "sent"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "new",
        "contacted",
        "qualified",
        "won",
        "lost"
      ]
    },
    "listing": {
      "type": "string",
      "description": "Optional: only leads for this listing of the user's.",
      "minLength": 1,
      "maxLength": 300
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "default": 1
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "lead_id": {
      "type": "integer",
      "minimum": 1,
      "description": "lead_id from list_leads."
    }
  },
  "required": [
    "lead_id"
  ],
  "additionalProperties": false
}

The companies the user watches on FirmLedger, newest first.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

The user's in-app FirmLedger notifications, newest first, with the unread count. Set unread_only for just the unread ones.

{
  "type": "object",
  "properties": {
    "unread_only": {
      "type": "boolean",
      "default": false
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 60,
      "default": 20
    }
  },
  "additionalProperties": false
}

The user's FirmLedger support tickets. Pass a ticket reference to read that ticket's full conversation.

{
  "type": "object",
  "properties": {
    "ticket": {
      "type": "string",
      "maxLength": 40,
      "description": "Optional ticket reference, e.g. \"TK-1A2B3C\"."
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "key_prefix": {
      "type": "string",
      "maxLength": 40,
      "description": "Optional: focus on one key by its prefix."
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "webhook_id": {
      "type": "integer",
      "minimum": 1,
      "description": "Optional: one destination, with its recent deliveries."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 25,
      "default": 10
    }
  },
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    },
    "name": {
      "type": "string",
      "maxLength": 120,
      "description": "Optional sender name; defaults to the member profile name."
    },
    "phone": {
      "type": "string",
      "maxLength": 40
    },
    "looking_for": {
      "type": "string",
      "maxLength": 140,
      "description": "Optional short subject or what the member needs."
    },
    "message": {
      "type": "string",
      "minLength": 10,
      "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."
    }
  },
  "required": [
    "listing",
    "message"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "lead_id": {
      "type": "integer",
      "minimum": 1
    },
    "message": {
      "type": "string",
      "minLength": 2,
      "maxLength": 4000,
      "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."
    }
  },
  "required": [
    "lead_id",
    "message"
  ],
  "additionalProperties": false
}

Move a lead in the user's business inbox to new, contacted, qualified, won or lost. Requires the user's confirmation.

{
  "type": "object",
  "properties": {
    "lead_id": {
      "type": "integer",
      "minimum": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "new",
        "contacted",
        "qualified",
        "won",
        "lost"
      ]
    },
    "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."
    }
  },
  "required": [
    "lead_id",
    "status"
  ],
  "additionalProperties": false
}

Add an approved company to the user's watchlist so they are notified when its record changes. Requires the user's confirmation.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    },
    "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."
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

Remove a company from the user's watchlist. Requires the user's confirmation.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    },
    "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."
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "subject": {
      "type": "string",
      "minLength": 4,
      "maxLength": 200
    },
    "category": {
      "type": "string",
      "enum": [
        "billing",
        "technical",
        "listing",
        "account",
        "verification",
        "other"
      ]
    },
    "body": {
      "type": "string",
      "minLength": 20,
      "maxLength": 5000,
      "description": "The issue in a few sentences."
    },
    "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."
    }
  },
  "required": [
    "subject",
    "category",
    "body"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "edit",
        "close",
        "remove",
        "delete"
      ]
    },
    "job_id": {
      "type": "integer",
      "minimum": 1
    },
    "title": {
      "type": "string",
      "maxLength": 80
    },
    "role_type": {
      "type": "string",
      "enum": [
        "Full-time",
        "Part-time",
        "Contract",
        "Internship",
        "Remote"
      ]
    },
    "location": {
      "type": "string",
      "maxLength": 80
    },
    "apply_url": {
      "type": "string",
      "maxLength": 400
    },
    "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."
    }
  },
  "required": [
    "action",
    "job_id"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "description": "One of the user's own listings.",
      "minLength": 1,
      "maxLength": 300
    },
    "title": {
      "type": "string",
      "minLength": 3,
      "maxLength": 80
    },
    "role_type": {
      "type": "string",
      "enum": [
        "Full-time",
        "Part-time",
        "Contract",
        "Internship",
        "Remote"
      ]
    },
    "location": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "City, or \"Remote\"."
    },
    "apply_url": {
      "type": "string",
      "maxLength": 400,
      "description": "Full https:// link to the job post or careers page."
    },
    "description": {
      "type": "string",
      "minLength": 30,
      "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."
    }
  },
  "required": [
    "listing",
    "title",
    "location",
    "apply_url",
    "description"
  ],
  "additionalProperties": false
}

Mark one notification (notification_id) or all of them (all: true) as read. Requires the user's confirmation.

{
  "type": "object",
  "properties": {
    "notification_id": {
      "type": "integer",
      "minimum": 1
    },
    "all": {
      "type": "boolean"
    },
    "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
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "description": "One of the user's own listings.",
      "minLength": 1,
      "maxLength": 300
    },
    "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."
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "description": "One of the user's own listings.",
      "minLength": 1,
      "maxLength": 300
    },
    "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."
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "description": "One of the user's own approved listings.",
      "minLength": 1,
      "maxLength": 300
    },
    "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."
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "description": "A listing the user owns or submitted.",
      "minLength": 1,
      "maxLength": 300
    },
    "reason": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2000,
      "description": "Why it should be removed (20+ characters)."
    },
    "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."
    }
  },
  "required": [
    "listing",
    "reason"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    },
    "method": {
      "type": "string",
      "enum": [
        "dns",
        "meta",
        "badge"
      ]
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 500,
      "description": "Public HTTPS destination for signed events."
    },
    "label": {
      "type": "string",
      "maxLength": 80
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "listing.approved",
          "listing.rejected",
          "listing.updated",
          "listing.created",
          "listing.deleted",
          "claim.verified"
        ]
      },
      "minItems": 1,
      "maxItems": 6
    },
    "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."
    }
  },
  "required": [
    "url",
    "events"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "ticket": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40,
      "description": "The ticket reference (e.g. TK-1A2B3C) or its id, from list_my_tickets."
    },
    "message": {
      "type": "string",
      "minLength": 2,
      "maxLength": 4000,
      "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."
    }
  },
  "required": [
    "ticket",
    "message"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "create",
        "update",
        "pause",
        "resume",
        "rotate_secret",
        "test",
        "retry_delivery",
        "delete"
      ]
    },
    "webhook_id": {
      "type": "integer",
      "minimum": 1,
      "description": "Required for every action except create."
    },
    "url": {
      "type": "string",
      "maxLength": 500,
      "description": "create/update: the receiver URL (https in production)."
    },
    "label": {
      "type": "string",
      "maxLength": 80
    },
    "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
    },
    "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."
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "create",
        "revoke",
        "update_scopes"
      ]
    },
    "label": {
      "type": "string",
      "maxLength": 60,
      "description": "create: a name for the key."
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "read:listings",
          "write:listings",
          "export",
          "manage:webhooks",
          "read:usage",
          "read:account",
          "write:account"
        ]
      },
      "minItems": 1,
      "uniqueItems": true,
      "maxItems": 9,
      "description": "Scope ids. Required for update_scopes; create defaults to the standard scopes."
    },
    "key_id": {
      "type": "integer",
      "minimum": 1,
      "description": "revoke/update_scopes: the key id from list_api_keys."
    },
    "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."
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {
    "listing": {
      "type": "string",
      "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.",
      "minLength": 1,
      "maxLength": 300
    },
    "name": {
      "type": "string",
      "maxLength": 120
    },
    "tagline": {
      "type": "string",
      "maxLength": 160
    },
    "description": {
      "type": "string",
      "maxLength": 4000
    },
    "website": {
      "type": "string",
      "maxLength": 300
    },
    "email": {
      "type": "string",
      "maxLength": 190
    },
    "phone": {
      "type": "string",
      "maxLength": 40
    },
    "country": {
      "type": "string",
      "maxLength": 80
    },
    "city": {
      "type": "string",
      "maxLength": 80
    },
    "region": {
      "type": "string",
      "maxLength": 80
    },
    "address": {
      "type": "string",
      "maxLength": 200
    },
    "logo_url": {
      "type": "string",
      "maxLength": 500
    },
    "founded": {
      "type": "string",
      "maxLength": 12
    },
    "size": {
      "type": "string",
      "maxLength": 40
    },
    "tags": {
      "type": "string",
      "maxLength": 300
    },
    "socials": {
      "description": "Social profile links keyed by network; use an empty object to clear. A JSON object string is also accepted.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "linkedin": {
              "type": "string",
              "maxLength": 500
            },
            "x": {
              "type": "string",
              "maxLength": 500
            },
            "facebook": {
              "type": "string",
              "maxLength": 500
            },
            "instagram": {
              "type": "string",
              "maxLength": 500
            },
            "youtube": {
              "type": "string",
              "maxLength": 500
            }
          },
          "additionalProperties": false
        },
        {
          "type": "string",
          "maxLength": 800
        }
      ]
    },
    "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."
    }
  },
  "required": [
    "listing"
  ],
  "additionalProperties": false
}

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).

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "archive",
        "unarchive",
        "delete"
      ]
    },
    "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."
    }
  },
  "required": [
    "action",
    "lead_id"
  ],
  "additionalProperties": false
}

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.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}