HAhappyscribe
Consent

Retrieve a consent event

get/consent_events/{id}

Request

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

Path parameters

idstring required
Example:cns_01k6d5e6f7g8h9j0k1m2n3p4qr

Consent event ID, beginning with cns_. Treat it as an opaque string. Integer ids are still accepted.

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.

Response

The consent event.

objectstring

Always consent_event.

idstring

Consent event ID, beginning with cns_. Treat it as an opaque string.

bot_idstring nullable

The bot this event belongs to, or null for a person-level event.

participant_emailstring nullable

The participant, or null for a room-wide notice.

action'notified' | 'accepted' | 'declined' | 'revoked' | 'deletion_requested'
  • notified — the person was told about the recording
  • accepted — they consented
  • declined — they said no to this meeting
  • revoked — they withdrew consent going forward
  • deletion_requested — they asked for their speech to be removed
occurred_atstring date-time

Example response

{
  "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.