NetworkAction

Public API representation of a network action (audit log entry). Immutable record of changes made to contacts/companies.

cursor
Type: string

Opaque cursor for pagination (use this to fetch next page)
details
Type: nullable

Type-specific details about this action
Details for note actions
archivedAt
Type: null | stringFormat: date-time

When this note was archived (UTC, ISO 8601). Null when the note is still active. Populated for archived rows and for predecessors in a supersede chain (a superseded predecessor is also archived in the same transaction). Only returned when include_archived=true is requested, since archived rows are hidden from the default action list response.

file
Type: nullable

Attached file information (if any)

Properties: 3
idempotencyKey
Type: null | string

Idempotency key used when creating this note (if applicable)

kind
enum
const:
note
message
Type: string

The note text content

noteType
Type: null | string

Activity sub-type: "call", "meeting", "email", "news". Null for plain notes.

oauthClientId
Type: null | string

OAuth client ID that created this note (if created via Public API)

supersededByActivityId
Type: null | string

Id of the successor note that supersedes this note (i.e., this note is the predecessor and has been replaced by a newer revision). Null when this note is still the active head of its chain. Only meaningful when the predecessor is returned, which requires include_archived=true or include_superseded=true.

supersedesActivityId
Type: null | string

Id of the predecessor note that this note supersedes (i.e., this note is the successor / current revision in a supersede chain). Null when this note is the original (not a revision of any other note).
etag
Type: string

ETag for optimistic concurrency control. Send this value as the If-Match header on PATCH /notes/{noteId} for archive, unarchive, and supersede operations. The header is mandatory on those endpoints (412 Precondition Failed on stale, 428 Precondition Required when omitted).
event
Type: null | string

Audit event type: "ContactCreated", "ContactUpdated", "LinkCreated", etc. Follow-up tasks use "task_added" and "task_completed". Only present for audit actions (type="audit").
id
Type: string

Unique identifier for this action
importId
Type: null | integer | stringFormat: int32

Import batch ID that triggered this action. Only present for actions originating from contact imports.
source
Type: null | string

Origin of this action: "PublicApi" (this API), "App" (the Propstreet app), "Agent" (an AI agent acting for a user), "Import" or "System". Null for historical data.
timestampUtc
Type: stringFormat: date-time

When this action occurred (UTC)
type
Type: string

Type of action: "note" or "audit" (legacy: "api"). A follow-up task and its completion are audit rows; their event names which of the two it is.
user
Type: nullable

User who performed this action (if available)

Properties: 2

NetworkActionDetails