consents/events

Retrieve events

Returns a list of events for a given organization ID and user ID or organization user ID

get/consents/events

Request

  • Base URL
    https://api.didomi.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.didomi.io/consents/events
  • Auth
    HTTP bearer

Query parameters

organization_idstring required

The ID of the organization for which to retrieve events

user_idstring

The Didomi user ID for which to retrieve events. You must provide either user_id or organization_user_id when querying events

organization_user_idstring

The organization user ID for which to retrieve events. You must provide either user_id or organization_user_id when querying events

statusstring

Filter events according to their status (possible values: confirmed, pending_approval). If this field is missing, only confirmed events are returned. To filter on multiple statuses in a single request, use the notation status[$in]: ?status[$in]=confirmed&status[$in]=pending_approval.

regulationstring

Filter events according to their regulation. Possible value is any existing regulation in the Regulations API (/compliance/v1/regulations). If this field is missing, only GDPR events are returned. To filter on multiple regulations in a single request, use the notation regulation[$in]: ?regulation[$in]=gdpr&regulation[$in]=cpra.

Response

A list of ConsentEvent objects

ConsentEvents[] required(unresolved $ref)

Changes

No recorded changes to this operation across all 10 revisions of this API.