---
title: "Get current session status"
method: GET
path: "/api/session"
tags: ["Session"]
---

# Get current session status

`GET /api/session`

Returns information about the current session (based on authentication)

## Response `200`

If the user is authenticated

- union
  - User
    - `username` string — Username of the user.
    - `scope` 'admin' | 'install' | 'update' | 'read'
    - `totp_enabled` boolean — Whether two-factor authentication is enabled/required using TOTP. Not available if Passkey is used.
    - `passkey` boolean — Whether this user authenticates using a Passkey.
    - `limited` boolean — In case the user was authenticated with a passwordless link, the scope of the API token used for generating that link is inherited to the user session. This flag is `true` if the user would have more permissions than currently given by the passwordless link.
  - TokenResponse
    - `id` string, required
    - `token` string, required — Only available if the token was freshly created.
    - `username` string — Username of the token.
    - `client_id` string — Client ID of the token.
    - `scope` 'admin' | 'install' | 'update' | 'read', required — Permission scope of the token.
    - `grant_type` 'one-time' — Grant type of the token
    - `expires` integer — Timestamp when the one-time token expires.
    - `url` string — Login URL for passwordless authentication tokens.

## Other responses

- `204` — If there are no records in the user database
- `401` — If the user is not authenticated
- `403` — If the Contao Manager is locked after three unsuccessful login attempts.

## Changes

> 45 revisions in range; 26 could not be searched.

- **2025-03-06** `4dc3bf84edf7` — 2 info
  - added the optional property `oneOf[#/components/schemas/User]/limited` to the response with the `200` status
  - removed the `invitation` enum value from the `oneOf[#/components/schemas/TokenResponse]/grant_type` response property for the response status `200`
- **2025-01-29** `b0fe14acdeaf` — 1 info
  - added the optional property `oneOf[#/components/schemas/User]/passkey` to the response with the `200` status
- **2024-11-07** `0caa21a70faf` — 1 info
  - added the optional property `oneOf[#/components/schemas/User]/totp_enabled` to the response with the `200` status
- **2024-11-06** `e06d9f9dee25` — 2 breaking, 2 warning, 1 info
  - the response property `oneOf[#/components/schemas/TokenResponse]/client_id` became optional for the status `200`
  - the response property `oneOf[#/components/schemas/TokenResponse]/username` became optional for the status `200`
  - removed the optional property `oneOf[#/components/schemas/User]/roles` from the response with the `200` status
  - added the new `invitation` enum value to the `oneOf[#/components/schemas/TokenResponse]/grant_type` response property for the response status `200`
  - …1 more
- …earlier changes not shown

[Full history](https://skmtc.dev/contao/apis/contao-manager-api/changes/api/session/get.md)

---

[API](https://skmtc.dev/contao/apis/contao-manager-api.md) · [All operations](https://skmtc.dev/contao/apis/contao-manager-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/contao/contao-manager-api/revisions/074d8046de13/schema)