---
title: "Get the Offline mode settings."
method: GET
path: "/offline/settings.json"
tags: ["Offline mode"]
---

# Get the Offline mode settings.

`GET /offline/settings.json`

## Request

- Base URL: `https://passbolt.local`
- URL: `https://passbolt.local/offline/settings.json`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/passbolt/apis/passbolt-api/docs/offline/settings.json/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the settings that apply to the organisation. Saving the settings is what enables Offline mode, so an empty body means the feature is switched off.

## Response `200`

Operation is successful

- object
  - `header` Header, required
    - `id` string, uuid, required
    - `status` 'success' | 'error', required
    - `servertime` integer, required
    - `action` string, uuid, required
    - `message` string, required
    - `url` string, uri, required
    - `code` integer, required
  - `body` union, required
    - OfflineSettings
      - `id` string, uuid, required
      - `max_session_duration` integer, required: How long a user stays authenticated offline before having to enter their passphrase again, in seconds.
      - `data_retention_period` integer, required: Maximum number of days encrypted data is kept on a user's device, counted from the last time that device reached the server.
      - `max_items` integer, required: Maximum number of items a single user can mark as available offline.
      - `created` string, date-time, required
      - `created_by` string, uuid, required
      - `modified` string, date-time, required
      - `modified_by` string, uuid, required
    - object: An empty object, returned when no settings have been saved. Offline mode is switched off in that case.

## Other responses

- `401`: Authentication required.

## Changes

- **2026-11-06** `8d72215e2274`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/passbolt/apis/passbolt-api/changes/offline/settings.json/get.md)

---

[API](https://skmtc.dev/passbolt/apis/passbolt-api.md) - [All operations](https://skmtc.dev/passbolt/apis/passbolt-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passbolt/apis/passbolt-api/revisions/8d72215e2274?raw)