consents/users

Retrieve users

Returns a list of end users and their consent status

get/consents/users

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/users
  • Auth
    HTTP bearer

Query parameters

organization_idstring required

The ID of the organization for which to retrieve users

organization_user_idstring

The organization user ID to retrieve (optional)

regulationstring

Filter user consents 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 ConsentUser objects

ConsentUsers[] required(unresolved $ref)

Changes

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