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

# Get the administration overview

> User and workspace counts, the five newest users and administrative actions, compact service checks, and configuration warnings. Activity is based on session refreshes within 30 days and excludes deactivated accounts. Requires all four instance permissions: `users:read`, `workspaces:read`, `audit:read`, and `system:read`; API keys are rejected. No credentials or audit metadata are returned.



## OpenAPI

````yaml /openapi.json get /admin/overview
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /admin/overview:
    get:
      tags:
        - Admin
      summary: Get the administration overview
      description: >-
        User and workspace counts, the five newest users and administrative
        actions, compact service checks, and configuration warnings. Activity is
        based on session refreshes within 30 days and excludes deactivated
        accounts. Requires all four instance permissions: `users:read`,
        `workspaces:read`, `audit:read`, and `system:read`; API keys are
        rejected. No credentials or audit metadata are returned.
      operationId: getAdminOverview
      responses:
        '200':
          description: Instance overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminOverview'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The caller lacks the instance permission or is authenticated with an
            API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiKeyRateLimited'
components:
  schemas:
    AdminOverview:
      type: object
      properties:
        users:
          type: object
          properties:
            total:
              type: integer
            activeLast30Days:
              type: integer
              description: >-
                Non-deactivated users with a session refreshed in the last 30
                days, counted once per user. Expired bans do not deactivate an
                account. Revoked or removed sessions do not contribute.
            deactivated:
              type: integer
          required:
            - total
            - activeLast30Days
            - deactivated
        workspaces:
          type: object
          properties:
            total:
              type: integer
            archived:
              type: integer
          required:
            - total
            - archived
        recentUsers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              email:
                type: string
              image:
                type:
                  - string
                  - 'null'
              createdAt:
                type: string
                format: date-time
            required:
              - id
              - name
              - email
              - image
              - createdAt
          maxItems: 5
        recentActions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              createdAt:
                type: string
                format: date-time
              action:
                type: string
                description: Dotted action name, for example `user.role_changed`.
              actor:
                type: object
                properties:
                  id:
                    type:
                      - string
                      - 'null'
                    description: Null when the administrator's account was deleted.
                  name:
                    type:
                      - string
                      - 'null'
                  email:
                    type:
                      - string
                      - 'null'
                required:
                  - id
                  - name
                  - email
              targetType:
                type: string
              targetId:
                type:
                  - string
                  - 'null'
              targetLabel:
                type:
                  - string
                  - 'null'
                description: The target's name or email when the action happened.
            required:
              - id
              - createdAt
              - action
              - actor
              - targetType
              - targetId
              - targetLabel
          maxItems: 5
        services:
          type: object
          properties:
            checkedAt:
              type: string
              format: date-time
            api:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                ok: working. warning: works with a problem, or is only partly
                configured. not_configured: optional and switched off, which is
                a healthy state. down: configured but not reachable.
            database:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                ok: working. warning: works with a problem, or is only partly
                configured. not_configured: optional and switched off, which is
                a healthy state. down: configured but not reachable.
            realtime:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                ok: working. warning: works with a problem, or is only partly
                configured. not_configured: optional and switched off, which is
                a healthy state. down: configured but not reachable.
            redis:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                ok: working. warning: works with a problem, or is only partly
                configured. not_configured: optional and switched off, which is
                a healthy state. down: configured but not reachable.
            email:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                ok: working. warning: works with a problem, or is only partly
                configured. not_configured: optional and switched off, which is
                a healthy state. down: configured but not reachable.
            storage:
              type: string
              enum:
                - ok
                - warning
                - not_configured
                - down
              description: >-
                ok: working. warning: works with a problem, or is only partly
                configured. not_configured: optional and switched off, which is
                a healthy state. down: configured but not reachable.
          required:
            - checkedAt
            - api
            - database
            - realtime
            - redis
            - email
            - storage
        warnings:
          type: array
          items:
            type: string
            enum:
              - smtp_not_configured
              - smtp_unreachable
              - redis_unreachable
              - storage_incomplete
              - storage_unreachable
              - registration_without_email
              - no_second_admin
      required:
        - users
        - workspaces
        - recentUsers
        - recentActions
        - services
        - warnings
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: Task not found
        code:
          type: string
          description: >-
            Stable UPPER_SNAKE_CASE code. Derived from the status unless a more
            specific code applies, such as VALIDATION_ERROR or
            MISSING_PERMISSION.
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                description: >-
                  Dotted path to the invalid input, prefixed with the request
                  part (body, query, params, header).
                example: body.title
              message:
                type: string
                example: Required
            required:
              - path
              - message
          description: Every validation issue, for VALIDATION_ERROR.
        missingPermissions:
          type: array
          items:
            type: string
          description: >-
            Permissions the caller lacks for this route, as resource:action, for
            MISSING_PERMISSION and API_KEY_SCOPE.
          example:
            - task:update
      required:
        - message
        - code
  responses:
    ApiKeyRateLimited:
      description: >-
        The API key exceeded its rate limit or usage quota. Wait the number of
        seconds in Retry-After before retrying. The X-RateLimit headers are sent
        only when the rate limit was hit.
      headers:
        Retry-After:
          description: >-
            Seconds to wait before retrying. Omitted when an exhausted usage
            quota never refills.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests the API key may make per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time in seconds when the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````

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