Skip to content
Primary navigation

Retrieve organization data retention

admin.organization.data_retention.retrieve() -> OrganizationDataRetention { object, type }
GET/organization/data_retention

Retrieves organization data retention controls.

ReturnsExpand Collapse
class OrganizationDataRetention { object, type }

Represents the organization’s data retention control setting.

object: :"organization.data_retention"

The object type, which is always organization.data_retention.

type: :zero_data_retention | :modified_abuse_monitoring | :enhanced_zero_data_retention | :enhanced_modified_abuse_monitoring

The configured organization data retention type.

One of the following:
:zero_data_retention
:modified_abuse_monitoring
:enhanced_zero_data_retention
:enhanced_modified_abuse_monitoring

Retrieve organization data retention

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

organization_data_retention = openai.admin.organization.data_retention.retrieve

puts(organization_data_retention)
{
    "object": "organization.data_retention",
    "type": "modified_abuse_monitoring"
}
Returns Examples
{
    "object": "organization.data_retention",
    "type": "modified_abuse_monitoring"
}