client.activityOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/activityactivity.list
Returns a bounded, target-owned activity stream filtered by product permissions and every domain scope implied by each event. Comments, internal content, and unscoped system events are excluded.
client.activity.list(options: ActivityListOptions)- Return form
Promise- Operation ID
listActivity- Required scopes
activity:read- Conditional scopes
contacts:readprojects:readtasks:read- SDK parameters
options: ActivityListOptions- Query request fields
cursor?: stringlimit?: integertargetType: stringtargetId: string- Success
200 Array<ActivityEvent> envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
activity.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.activity.pages(options: ActivityListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.