> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Get session retention settings

> Read your session retention rules: whether sessions are erased after closing or after inactivity, each threshold in days, and what an erasure also removes.

Needs the `session-retention:read` scope. Both rules are off until someone turns one on.

For what each rule and setting does, and what an erasure removes, see
[Session retention](https://docs.open.cx/security/session-retention.md).


## OpenAPI

````yaml get /session-retention/settings
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /session-retention/settings:
    get:
      tags:
        - Session retention
      summary: Get session retention settings
      description: >-
        The rules that permanently erase sessions after they have been closed,
        or inactive, for a number of days, and what else each erasure removes.
        Both rules are off until turned on.
      operationId: getSessionRetentionSettings
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionRetentionSettingsDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    SessionRetentionSettingsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SessionRetentionSettingsDto'
      type: object
      properties:
        after_closing_enabled:
          type: boolean
          description: >-
            Erase a session once it has stayed closed for `after_closing_days`
            days. A reopened session never matches.
        after_closing_days:
          type: integer
          minimum: 15
          maximum: 120
          description: >-
            Days after a session is closed before it is erased: a whole number
            from 15 to 120.
        after_inactivity_enabled:
          type: boolean
          description: >-
            Erase a session once it has had no activity for
            `after_inactivity_days` days. An open session is closed first.
        after_inactivity_days:
          type: integer
          minimum: 15
          maximum: 120
          description: >-
            Days without activity before a session is erased: a whole number
            from 15 to 120.
        erase_title:
          type: boolean
          description: Erasure also replaces the session title.
        erase_custom_data:
          type: boolean
          description: Erasure also empties the session custom data.
        erase_ai_traces:
          type: boolean
          description: Erasure also removes the AI traces recorded for the session.
        erase_summary:
          type: boolean
          description: Erasure also clears the session summary.
        anonymize_contact:
          type: boolean
          description: Erasure also removes every link between the session and its contact.
      required:
        - after_closing_enabled
        - after_closing_days
        - after_inactivity_enabled
        - after_inactivity_days
        - erase_title
        - erase_custom_data
        - erase_ai_traces
        - erase_summary
        - anonymize_contact
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.