Skip to main content
GET
List activities for a deal or lead

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Query Parameters

entity_type
enum<string>
required
Available options:
deal,
lead
entity_id
string<uuid>
required
activity_type
string

Filter by a configured activity type key (e.g. call).

limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0

Deprecated (HL-D6). Use cursor instead — offset paging repeats or skips rows when activities are logged mid-scan. Still honoured; responses that use it carry Deprecation / Sunset headers (sunset 2027-10-01). Ignored when cursor is sent.

Required range: x >= 0
cursor
string

Opaque cursor from a previous page's next_cursor. Echo it back as-is; a cursor that does not decode is a 400 VALIDATION_ERROR.

Response

Activities retrieved

success
enum<boolean>
Available options:
true
data
object
meta
object