Sign in
purposes

Retrieve a purpose

Returns a single purpose with the given ID

get/metadata/purposes/{id}

Path parameters

idstring required

The ID of the purpose to retrieve

Response

A Purpose object

idstring required

Purpose ID

descriptionobject

Name of the purpose

detailsobject

Details of the purpose

enabled_status_descriptionobject

Description of the purpose when the sdk status for the user for this purpose is enabled

disabled_status_descriptionobject

Description of the purpose when the sdk status for the user for this purpose is disabled

referenceobject

The reference number uniquely identifies the purpose in an official classification like the one from the CNIL

organization_idstring

Id of organization which purpose belongs to. If id is null, purpose is global

created_atstring date-time

Creation date of the purpose

updated_atstring date-time

Last update date of the purpose

regulations_idstring[]

An array of regulation IDs the purpose supports

typestring

The purpose type discriminator.

metadataobject

Metadata for additional information

opted_out_by_gpcboolean

Whether the purpose is opted out when a Global Privacy Control (GPC) signal applies

necessary_to_generate_revenueboolean

Whether the purpose is necessary to generate revenue (Consent or Pay)

Changes