FLfloqer
ackDB

Fuzzy search → the single closest company (hydrated like /full)

Per-field fuzzy search returning the single closest company, fully hydrated exactly like /entities/full (entity, identity links, traits, contacts, plus paginated events / raw payloads / conversations / files) — plus a matchedOn block explaining the hit. The fuzzy sibling of /entities/full and the company analog of /contacts/search: send whichever field(s) you're searching — q (across name + all identity links), name, domain, identity (any identity-link value, optionally pinned with identityType); at least one required, all ANDed. Ranked case-insensitive substring per field (exact > prefix > contains, score = sum of per-field tiers) and returns exactly one company. No match → 404. Accepts the same collection controls as /entities/full (eventsLimit, rawLimit, conversationsLimit, filesLimit + their filters, contacts=false, conversationSummary=false, and *Limit=0 to omit a collection).

get/api/v1/ackdb/entities/search

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Query parameters

qstring

Free text to match against the entity name + all identity-link values (domain, slack_channel_id, stripe_customer_id, …). Case-insensitive substring; the closest single company is returned.

namestring

Match against the company name only.

domainstring

Match against the company's domain identity links only.

identitystring

Match against any identity-link value (Stripe customer ID, Slack channel ID, CRM account ID, …). Combine with identityType to pin one link type.

identityTypestring

Restrict identity to one identity-link type (e.g. stripe_customer_id, slack_channel_id, crm_account_id). Only meaningful together with identity.

contactLimitinteger

Cap on nested contacts (0–1000). Omit to return all (the /full default). When set, the response also includes contactCount (total active contacts) so callers know whether there are more.

Response

The closest company, hydrated like GET /entities/full, plus a matchedOn block.

dataobject required

Same shape as GET /entities/full data: entity, identityLinks, traits, contacts (+ contactCount when contactLimit is set), events, rawPayloads, conversations, files, conversationSummary.

Changes

No recorded changes to this operation across all 1 revision of this API.