FLfloqer
ackDB

Get the full entity object by identity link

Resolve an entity by an identity-link value (pass just externalIdValue - a domain, slack_channel_id, stripe_customer_id, email, …; externalIdType and source are optional disambiguators) and return the complete entity object in one response: entity, identity links, traits, contacts, plus paginated windows over events, raw payloads, conversations, and files. Each high-volume collection is independently tunable (*Limit/*Offset + filters) and returns latest-first with a total, so callers can page the long tail. A bare call returns a complete-but-bounded object; set a collection's *Limit=0 to omit it. Differs from /entities/{entityId}/profile (keyed by entityId, last 10 events only).

get/api/v1/ackdb/entities/full

Request

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

Query parameters

externalIdValuestring required

The identifier to resolve - a domain, slack_channel_id, stripe_customer_id, email, etc. This value alone resolves the entity in the common case.

externalIdTypestring

OPTIONAL. Identity-link type. Not needed to resolve (the value is unique); pass it only to disambiguate a value registered under more than one type (otherwise a collision returns 409).

sourcestring

OPTIONAL. Source type (e.g. slack, stripe). An extra disambiguator only; never required to resolve.

eventsLimitinteger

Max events to return (0–500, default 50; 0 omits the collection).

eventsOffsetinteger

Event pagination offset (default 0).

eventsSourcestring

Filter events by source (e.g. slack).

eventsTypestring

Filter events by event type (e.g. slack_message).

eventsSincestring date-time

Only events at/after this ISO timestamp.

eventsUntilstring date-time

Only events at/before this ISO timestamp.

rawLimitinteger

Max raw payloads (0–500, default 20; 0 omits).

rawOffsetinteger

Raw payload pagination offset (default 0).

conversationsLimitinteger

Max conversations (0–200, default 20; 0 omits).

conversationsOffsetinteger

Conversation pagination offset (default 0).

conversationsSourcestring

Filter conversations by source.

conversationsTopicstring

Filter conversations by topic.

conversationsSentimentstring

Filter conversations by sentiment.

conversationsSincestring date-time

Only conversations at/after this ISO timestamp.

conversationsUntilstring date-time

Only conversations at/before this ISO timestamp.

filesLimitinteger

Max files (0–500, default 50; 0 omits).

filesOffsetinteger

File pagination offset (default 0).

filesSourcestring

Filter files by source.

filesTypestring

Filter files by file type.

filesProcessedboolean

Filter by processed state (true/false).

contactsboolean

Set false to omit the contacts list.

conversationSummaryboolean

Set false to omit the conversation rollup.

Response

The full entity object. A collection key is present only when its *Limit > 0 (and conversationSummary only when threads exist).

Example response

{
  "data": {
    "entity": {
      "entityId": "01HXYZ123456789ABCDEFGH",
      "name": "Acme Corp"
    },
    "identityLinks": [
      {
        "entityId": "01HXYZ123456789ABCDEFGH",
        "source": "slack",
        "externalIdType": "slack_channel_id",
        "externalIdValue": "C04ABC",
        "confidence": 1
      }
    ],
    "traits": [
      {
        "entityId": "01HXYZ123456789ABCDEFGH",
        "traitKey": "slack_message_count",
        "valueNumber": 42,
        "source": "slack",
        "workflow": "slack-ingestion",
        "confidence": 1
      }
    ],
    "events": {
      "data": [
        {
          "id": "01HXYZ123456789ABCDEFGH",
          "source": "slack",
          "eventType": "message",
          "summary": "Customer asked about pricing in #acme-corp"
        }
      ]
    },
    "rawPayloads": {
      "data": [
        {
          "id": "01HXYZ123456789ABCDEFGH",
          "source": "slack"
        }
      ]
    },
    "conversations": {
      "data": [
        {
          "source": "slack"
        }
      ]
    },
    "files": {
      "data": [
        {
          "source": "slack",
          "fileName": "q4-proposal.pdf",
          "fileType": "application/pdf",
          "fileSizeBytes": 2048576
        }
      ]
    }
  }
}

Changes

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