> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Get session configuration defaults > Returns effective team or project defaults, explicit overrides, and their source. Requires `sessions:read`. Project tokens only access resources in their own project. ## OpenAPI ````yaml api-reference/features/operate.json GET /platform/session-configuration openapi: 3.0.3 info: title: Operate API methods version: 1.0.0 description: Task-focused operate methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/session-configuration: get: tags: - Session Configuration summary: Get session configuration defaults description: >- Returns effective team or project defaults, explicit overrides, and their source. Requires `sessions:read`. Project tokens only access resources in their own project. operationId: managementGetSessionConfigurationDefaults parameters: - name: projectId in: query required: false schema: type: string description: Identifier of the Polymorfa project that owns this resource. responses: '200': description: Success headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: type: object additionalProperties: false properties: data: allOf: - $ref: >- #/components/schemas/management__SessionConfigurationView description: Structured data carried by this object. required: - data '401': $ref: '#/components/responses/management__Unauthorized' '403': $ref: '#/components/responses/management__Forbidden' '404': $ref: '#/components/responses/management__NotFound' security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com components: schemas: management__SessionConfigurationView: type: object properties: requestedHistory: type: object properties: mode: type: string enum: - metadata_only - deliver description: |- Operating mode selected for this feature. **Allowed values** | Value | Meaning | | --- | --- | | `metadata_only` | Metadata only. | | `deliver` | Deliver. | requestFull: type: boolean description: Whether request full. required: - mode - requestFull additionalProperties: false description: >- Structured requested history values for this management session configuration view. historyConsent: type: string enum: - pending - accepted - declined description: >- Specifies history consent for this management session configuration view. **Allowed values** | Value | Meaning | | --- | --- | | `pending` | Pending. | | `accepted` | Accepted. | | `declined` | Declined. | effective: type: object properties: observation: type: object properties: presenceMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for presence. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | typingMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for typing. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | labelMode: type: string enum: - 'off' - events - cache - project description: |- Behavior selected for label. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | | `project` | Project. | quickReplyMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for quick reply. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | required: - presenceMode - typingMode - labelMode - quickReplyMode additionalProperties: false description: Structured observation values for this effective. historySync: type: object properties: mode: type: string enum: - metadata_only - deliver description: |- Operating mode selected for this feature. **Allowed values** | Value | Meaning | | --- | --- | | `metadata_only` | Metadata only. | | `deliver` | Deliver. | requestFull: type: boolean description: Whether request full. required: - mode - requestFull additionalProperties: false description: History synchronization behavior for newly connected sessions. hms: anyOf: - type: object properties: enabled: type: boolean enum: - false description: |- Whether this feature is enabled. **Allowed values** | Value | Meaning | | --- | --- | | `false` | False. | required: - enabled additionalProperties: false - type: object properties: enabled: type: boolean enum: - true description: |- Whether this feature is enabled. **Allowed values** | Value | Meaning | | --- | --- | | `true` | True. | region: type: string pattern: ^[a-z0-9][a-z0-9-]{0,31}$ description: |- Specifies region for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[a-z0-9][a-z0-9-]{0,31}$` | policy: type: string enum: - short - standard - extended - compliance - enterprise_archive description: |- Specifies policy for this any of. **Allowed values** | Value | Meaning | | --- | --- | | `short` | Short. | | `standard` | Standard. | | `extended` | Extended. | | `compliance` | Compliance. | | `enterprise_archive` | Enterprise archive. | retentionDays: type: integer minimum: 1 maximum: 2555 description: |- Specifies retention days for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `2555` (inclusive) | policyVersion: type: string minLength: 1 maxLength: 128 description: |- Specifies policy version for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `128` characters | legalHold: type: boolean description: Whether legal hold. required: - enabled - region - policy additionalProperties: false description: >- Specifies hms for this effective. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `enabled`: `false`; Required fields: `enabled` | | Alternative 2 | Type: `object`; Field `enabled`: `true`; Field `policy`: `short` or `standard` or `extended` or `compliance` or `enterprise_archive`; Required fields: `enabled`, `region`, `policy` | required: - observation - historySync - hms additionalProperties: false description: >- Structured effective values for this management session configuration view. overrides: type: object properties: historySync: type: object properties: mode: type: string enum: - metadata_only - deliver description: |- Operating mode selected for this feature. **Allowed values** | Value | Meaning | | --- | --- | | `metadata_only` | Metadata only. | | `deliver` | Deliver. | requestFull: type: boolean description: Whether request full. additionalProperties: false description: History synchronization behavior for newly connected sessions. hms: anyOf: - type: object properties: enabled: type: boolean enum: - false description: |- Whether this feature is enabled. **Allowed values** | Value | Meaning | | --- | --- | | `false` | False. | required: - enabled additionalProperties: false - type: object properties: enabled: type: boolean enum: - true description: |- Whether this feature is enabled. **Allowed values** | Value | Meaning | | --- | --- | | `true` | True. | region: type: string pattern: ^[a-z0-9][a-z0-9-]{0,31}$ description: |- Specifies region for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Pattern | `^[a-z0-9][a-z0-9-]{0,31}$` | policy: type: string enum: - short - standard - extended - compliance - enterprise_archive description: |- Specifies policy for this any of. **Allowed values** | Value | Meaning | | --- | --- | | `short` | Short. | | `standard` | Standard. | | `extended` | Extended. | | `compliance` | Compliance. | | `enterprise_archive` | Enterprise archive. | retentionDays: type: integer minimum: 1 maximum: 2555 description: |- Specifies retention days for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `1` through `2555` (inclusive) | policyVersion: type: string minLength: 1 maxLength: 128 description: |- Specifies policy version for this any of. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `128` characters | legalHold: type: boolean description: Whether legal hold. required: - enabled - region - policy additionalProperties: false description: >- Specifies hms for this override. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `enabled`: `false`; Required fields: `enabled` | | Alternative 2 | Type: `object`; Field `enabled`: `true`; Field `policy`: `short` or `standard` or `extended` or `compliance` or `enterprise_archive`; Required fields: `enabled`, `region`, `policy` | observation: type: object properties: presenceMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for presence. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | typingMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for typing. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | labelMode: type: string enum: - 'off' - events - cache - project description: |- Behavior selected for label. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | | `project` | Project. | quickReplyMode: type: string enum: - 'off' - events - cache description: |- Behavior selected for quick reply. **Allowed values** | Value | Meaning | | --- | --- | | `off` | Off. | | `events` | Events. | | `cache` | Cache. | additionalProperties: false description: Structured observation values for this override. additionalProperties: false description: >- Structured overrides values for this management session configuration view. sources: type: object properties: observation.presenceMode: type: string enum: - platform - team - project - session description: |- Behavior selected for observation.presence. **Allowed values** | Value | Meaning | | --- | --- | | `platform` | Platform. | | `team` | Team. | | `project` | Project. | | `session` | Session. | observation.typingMode: type: string enum: - platform - team - project - session description: |- Behavior selected for observation.typing. **Allowed values** | Value | Meaning | | --- | --- | | `platform` | Platform. | | `team` | Team. | | `project` | Project. | | `session` | Session. | observation.labelMode: type: string enum: - platform - team - project - session description: |- Behavior selected for observation.label. **Allowed values** | Value | Meaning | | --- | --- | | `platform` | Platform. | | `team` | Team. | | `project` | Project. | | `session` | Session. | observation.quickReplyMode: type: string enum: - platform - team - project - session description: |- Behavior selected for observation.quick reply. **Allowed values** | Value | Meaning | | --- | --- | | `platform` | Platform. | | `team` | Team. | | `project` | Project. | | `session` | Session. | historySync.mode: type: string enum: - platform - team - project - session - consent description: |- Behavior selected for history sync.mode. **Allowed values** | Value | Meaning | | --- | --- | | `platform` | Platform. | | `team` | Team. | | `project` | Project. | | `session` | Session. | | `consent` | Consent. | historySync.requestFull: type: string enum: - platform - team - project - session - consent description: |- Specifies history sync.request full for this source. **Allowed values** | Value | Meaning | | --- | --- | | `platform` | Platform. | | `team` | Team. | | `project` | Project. | | `session` | Session. | | `consent` | Consent. | hms: type: string enum: - platform - team - project - session description: |- Specifies hms for this source. **Allowed values** | Value | Meaning | | --- | --- | | `platform` | Platform. | | `team` | Team. | | `project` | Project. | | `session` | Session. | required: - observation.presenceMode - observation.typingMode - observation.labelMode - observation.quickReplyMode - historySync.mode - historySync.requestFull - hms additionalProperties: false description: >- Structured sources values for this management session configuration view. revisions: type: object properties: team: type: integer minimum: 0 description: |- Specifies team for this revision. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | project: type: integer minimum: 0 description: |- Specifies project for this revision. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | session: type: integer minimum: 0 description: |- Identifier of the connected Polymorfa session. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | required: - team - project - session additionalProperties: false description: >- Structured revisions values for this management session configuration view. application: type: object properties: desiredGeneration: type: integer minimum: 0 description: |- Specifies desired generation for this application. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | appliedGeneration: type: integer minimum: 0 description: |- Specifies applied generation for this application. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | status: type: string enum: - pending - applied description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `pending` | Pending. | | `applied` | Applied. | required: - desiredGeneration - appliedGeneration - status additionalProperties: false description: >- Structured application values for this management session configuration view. required: - requestedHistory - effective - overrides - sources - revisions additionalProperties: false management__ErrorEnvelope: type: object required: - error - data - docs properties: error: type: object required: - type - code - message - param properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string description: Stable failure code. Use this value for programmatic handling. message: type: string description: Safe explanation of the failure. param: type: string nullable: true description: |- Invalid request field, or null when no field applies. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Documentation link to this failure code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | responses: management__Unauthorized: description: Missing/invalid credential for this audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Forbidden: description: Authenticated but lacks the required scope/role/audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__NotFound: description: >- The requested resource was not found inside the authenticated team or project scope. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Send your team API key or project token as `Authorization: Bearer `. The credential must have the required permissions. Project tokens can access only their own project. ````