HAhappyscribe
Consent

List consent events

Returns the workspace's consent events, newest first — the outcomes the Trust Engine records as it collects consent for your meetings.

get/consent_events

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Query parameters

workspace_idstring required
Example:wks_01k6a2r9s8x7c2dvq3m5n6p4ab

Workspace ID, beginning with wks_. Treat it as an opaque string. Integer workspace ids are still accepted.

bot_idstring

Only events for this bot, e.g. bot_01k0h4r9s8x7c2dvq3m5n6p4ab.

participant_emailstring

Only events for this participant.

action'notified' | 'accepted' | 'declined' | 'revoked' | 'deletion_requested'

Only events with this outcome.

sincestring date-time

Only events that occurred at or after this ISO 8601 timestamp.

pageinteger
per_pageinteger

Results per page, max 100.

Response

The workspace's consent events.

_linksobject

Contains next.url when more pages exist.

Example response

{
  "results": [
    {
      "object": "consent_event",
      "id": "cns_01k6d5e6f7g8h9j0k1m2n3p4qr",
      "bot_id": "bot_01k0h4r9s8x7c2dvq3m5n6p4ab",
      "participant_email": "carmen@acme.com",
      "action": "accepted",
      "occurred_at": "2026-08-14T14:02:11Z"
    }
  ]
}

Changes

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