purposes-groups

Retrieve a list of purposes groups

Returns a list of all purposes groups

get/metadata/purposes-groups

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

Query parameters

$limitinteger

Number of results to return

$skipinteger

Number of results to skip

$sortobject

Property to sort results

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

Query parameters to filter

Response

A list of PurposesGroup objects

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.