latestOpenAPI 3.0.22026-08-1719091299.2 KB

c82339816c36

consents/events6

consents/proofs2

consents/tokens1

consents/users5

cookies6

dashboards-urls1

domains6

Integrations1

keys6

languages1

members5

metadata31

metadata-purpose-regulation-override6

notices38

organizations6

organizations-source-systems2

partners6

partners-default-purposes2

partners-legitimate-interest-purposes2

partners-spi-purposes2

partners-storages6

premium-features4

privacy-centers6

purposes7

purposes-groups6

quotas2

secrets6

sessions2

sso-connections3

taxonomies6

vendors6

widgets/notices/remote-configs1

keys

Retrieve an API key

Returns a single API key with the given ID

get/keys/{id}

Path parameters

idstring required

The ID of the API key to retrieve

Response

An APIKey object

idstring

Unique ID of the API key

namestring

Name of the API key to help identify it. This could be the name of the app or team that will be using it, or a short description of what the key will be used for

descriptionstring

Description of the API key

organization_idstring

ID of the organization that owns the API key

created_atstring

Creation date of the API key (ISO8601)

enabledboolean

Status of the API key. A disabled API key cannot be used for obtaining a token. Already issued tokens remain valid until their expiration.

is_internalboolean

Marks an API key as internal. These keys are managed by Didomi. Internal keys are excluded from list results unless explicitly requested.