notices

Retrieve a notice text

Returns a single notice text

get/widgets/notices/texts/{id}

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/widgets/notices/texts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the notice text to retrieve

Response

A NoticeText object

idstring required

The ID of the text

organization_idstring required

The ID of the organization that owns this text

namestring required

The name of the text. This is used for easily distinguishing between multiple texts and is not displayed to end users for consent collection.

platformsstring[] required

List of platforms that the content can be used on

defaultboolean required

Whether the text is the default text for the organization and the platform(s)

created_atstring date-time required

Creation date of the text

updated_atstring date-time required

Last update date of the text

versionnumber required

Revision number of the text

Changes

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