ackDB

List persons

Paginated person list. Each row carries affiliationCount (contact edges), keyCount (durable keys) and isInternal (any edge with is_external=false), so a list view needs no follow-up calls. Tombstoned (merged) persons are hidden unless status=merged.

get/api/v1/ackdb/persons

Request

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

Query parameters

qstring

Case-insensitive substring on the name.

status'active' | 'merged'

Identity lifecycle — NOT employment state (that lives on each contact edge).

keyTypestring

Only persons holding a durable key of this type, e.g. linkedin_url.

internalboolean

true = internal staff (some edge has is_external=false); false = external humans only.

affiliatedboolean

true = has ≥1 contact edge; false = edge-less (keyless singletons, or a person whose only contact was hard-deleted). Omit for both.

limitinteger
offsetinteger

Response

{ data: PersonListItem[], total, limit, offset }.

dataunknown required

Changes

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