Sign in

v1

latestOpenAPI 3.0.22026-07-1319091298.3 KB
organizations

Retrieve an organization

Returns a single organization with the given ID

get/organizations/{id}

Path parameters

idstring required

The ID of the organization to retrieve

Response

An Organization object

idstring required

Organization ID

namestring required

Name of the organization

websitestring uri

Website URL of the organization

created_atstring date-time

Creation date of the organization

updated_atstring date-time

Last update date of the organization

industry_idstring

Identifier of industry that the organization belongs to

analytics_urlstring

URL to a public Redash dashboard

public_api_keystring

Public API key of the organization (for consent collection on public properties)

versionnumber

Revision number of the organization object

validate_purpose_idboolean

Enable or disable the validation of the purposes in the consent API

disable_preferences_in_consentsboolean

Allow or disallow the use of preferences of the consents object in the consent API

auth_enabledboolean

Enable or disable authentication for end users

auth_allow_user_creationboolean

Enable or disable creation of an end user on authentication if it doesn't exist

auth_message_prioritystring[]

List the priority of message channels, from the most important to the least

allow_tcf_with_custom_textboolean

Whether the organization is allowed to publish consent notices without a standard approved text

self_registerboolean

Whether the organization is created by a user (true) or via Didomi's Customer Succes team (false)

organization_group_idstring

Identifier of the organization group that the organization belongs to

organization_group_namestring nullable

Name of the organization group that the organization belongs to

iab_tcf_cmp_idinteger nullable

The IAB TCF CMP ID of the organization. If available, the ID will be added to generated TCF consent strings. If not available, the ID will be set to Didomi. If an ID is provided, it must be present in the IAB TCF CMP list (https://cmplist.consensu.org/v2/cmp-list.json).

allow_chat_supportboolean

Controls wether the organization should be allowed to contact support via chat