ackDB

List and filter entities

Returns a paginated list of entities. Supports text search across entity names and multi-trait filtering via traitFilter query params.

Trait filters: Each traitFilter param uses traitKey:operator:value format. Multiple filters are combined with AND logic.

Operators: eq, neq (string/text comparison), gt, gte, lt, lte (numeric), is_null, is_not_null (existence check - no value needed).

Examples:

  • ?traitFilter=stripe_plan:eq:enterprise - entities on enterprise plan
  • ?traitFilter=stripe_total_paid_cents:gte:10000 - entities that paid >= $100
  • ?traitFilter=stripe_plan:eq:enterprise&traitFilter=stripe_status:eq:active - enterprise + active
  • ?traitFilter=stripe_plan:is_null - entities without a Stripe plan

Hidden companies (#493, #505): a company whose only ingested evidence comes from a source flagged contextOnly (job → a past employer, education → a school) is context on somebody's record, not an account. A company minted solely as a relationship endpoint is also hidden until real evidence arrives. Both are EXCLUDED from this browse list; pass includeReference=true to include them. They remain reachable by id, by domain, and via GET /entities/search.

Internal companies (#567): a company holding a domain link listed in internal_domains is the deployment ITSELF, never an account. Same treatment: excluded here, revealed by includeReference=true, always reachable by id/domain/search. Unlike a reference company it is never promoted by activity — data landing on your own domain is still your own domain.

get/api/v1/ackdb/entities

Request

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

Query parameters

searchstring

Search filter applied to entity name (case-insensitive partial match).

traitFilterstring[]

Trait filter in traitKey:operator:value format. Repeat for multiple filters (AND logic). Operators: eq, neq, gt, gte, lt, lte, is_null, is_not_null.

limitinteger

Maximum number of entities to return.

offsetinteger

Number of entities to skip for pagination.

includeReferenceboolean

Include hidden companies: reference companies (their only ingested evidence comes from a contextOnly source — job history or education, #493), internal companies (a domain link in internal_domains, #567), and graph-only relationship endpoints (#505). All are excluded by default.

Response

Paginated list of entities

Example response

{
  "data": [
    {
      "entityId": "01HXYZ123456789ABCDEFGH",
      "name": "Acme Corp"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 50,
    "totalIsLowerBound": true
  }
}

Changes

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