purposes-groups

Retrieve a group of purposes

Returns a single group with the given ID

get/metadata/purposes-groups/{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/metadata/purposes-groups/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the group to retrieve

Response

A PurposesGroup object

idstring

Group ID

namestring required

Name of the group

descriptionstring

Description of the group

purposes_idstring[]

Purposes that belong to the group

organization_idstring

ID of the organization that owns the group. If ID is null, the group is global.

created_atstring date-time

Creation date of the purpose

updated_atstring date-time

Last update date of the purpose

Changes

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