Lockally Dashboard API

Tenant dashboard: user insights, audit, integrations, health, security, storage

GitHub OpenAPI

Operations 7

GET /v1/user-insights User insights for the dashboard #
GET /v1/audit-summary Audit summary for the dashboard #
GET /v1/integrations-summary Integrations summary for the dashboard #
GET /v1/security Security overview for the dashboard #
GET /v1/storage Storage usage for the dashboard #
GET /v1/domains/status Domain health status for the dashboard #
GET /v1/health Full tenant health report #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/lockally-com:lockally-com-dashboard-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lockally-com-dashboard-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: lockally control plane Dashboard API
  version: 0.1.0
  summary: REST API for managing tenants, domains, mailboxes, and outbound mail
  description: 'The lockally control plane lets integrators and direct customers manage

    everything except actual mail data flow (which uses standard JMAP / IMAP /

    SMTP-submission against the data plane endpoints).


    **Authentication.** All `/v1/*` endpoints require a Bearer API key in the

    `Authorization` header. Keys are formatted `lk_live__`,

    or `lk_test_` for a test key. Create keys in the dashboard, or with

    `POST /v1/api-keys` using a key that holds `tenant:admin`.


    The key''s plan is checked on every request, so a key stops working if the

    account moves to a plan without API access, and works again if it moves back.


    **Errors.** Failures return RFC 9457

    `application/problem+json` documents.


    **Scopes.** Each endpoint requires a specific scope on the presented key.

    Insufficient scope returns `403` with the required scope name in `detail`.'
  contact:
    name: lockally support
    email: support@lockally.com
  license:
    name: AGPL-3.0-only OR LicenseRef-LOC-Commercial
    identifier: AGPL-3.0-only
servers:
- url: https://api.lockally.com
  description: Production
- url: http://127.0.0.1:8081
  description: Local development / spike
security:
- bearerAuth: []
tags:
- name: Dashboard
  description: 'Tenant dashboard: user insights, audit, integrations, health, security, storage'
paths:
  /v1/user-insights:
    get:
      tags:
      - Dashboard
      operationId: getUserInsights
      x-required-scope: tenant:read
      summary: User insights for the dashboard
      responses:
        '200':
          description: User insights
          content:
            application/json:
              schema:
                type: object
                properties:
                  recently_added:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserEvent'
                  recently_suspended:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserEvent'
                  inactive_30d:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserEvent'
                  seats_used:
                    type: integer
                  seats_alloc:
                    type: integer
                  seats_capped:
                    type: boolean
                    description: True only on tiers with a hard seat cap (Free, Founder). On unlimited/per-seat tiers seats_alloc merely tracks the live mailbox count, so seats_used == seats_alloc is normal and must not be read as 'at capacity'.
                  generated_at:
                    type: string
                    format: date-time
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/audit-summary:
    get:
      tags:
      - Dashboard
      operationId: getAuditSummary
      x-required-scope: tenant:read
      summary: Audit summary for the dashboard
      responses:
        '200':
          description: Audit summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  admin_actions_today:
                    type: integer
                  recent_logins:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuditEvent'
                  recent_exports:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuditEvent'
                  deleted_mailboxes:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuditEvent'
                  generated_at:
                    type: string
                    format: date-time
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/integrations-summary:
    get:
      tags:
      - Dashboard
      operationId: getIntegrationsSummary
      x-required-scope: tenant:read
      summary: Integrations summary for the dashboard
      responses:
        '200':
          description: Integrations summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  api_requests_today:
                    type: integer
                  active_api_keys:
                    type: integer
                  api_keys:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                        prefix:
                          type: string
                        last_used_at:
                          type: string
                          format: date-time
                          nullable: true
                  webhook_failures:
                    type: integer
                  webhooks_total:
                    type: integer
                  webhooks:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                          format: uri
                        paused:
                          type: boolean
                        consecutive_failures:
                          type: integer
                        last_failure_at:
                          type: string
                          format: date-time
                          nullable: true
                  generated_at:
                    type: string
                    format: date-time
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/security:
    get:
      tags:
      - Dashboard
      operationId: getSecurity
      x-required-scope: tenant:read
      summary: Security overview for the dashboard
      responses:
        '200':
          description: Security overview
          content:
            application/json:
              schema:
                type: object
                properties:
                  overall_status:
                    type: string
                    enum:
                    - healthy
                    - warning
                    - critical
                  stats:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                        value:
                          type: integer
                        trend:
                          type: string
                  alerts:
                    type: array
                    items:
                      type: object
                      properties:
                        level:
                          type: string
                          enum:
                          - info
                          - warning
                          - critical
                        message:
                          type: string
                        time:
                          type: string
                          format: date-time
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/storage:
    get:
      tags:
      - Dashboard
      operationId: getStorage
      x-required-scope: tenant:read
      summary: Storage usage for the dashboard
      responses:
        '200':
          description: Storage usage
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_bytes:
                    type: integer
                    format: int64
                  alloc_bytes:
                    type: integer
                    format: int64
                  per_seat_bytes:
                    type: integer
                    format: int64
                  top_mailboxes:
                    type: array
                    items:
                      type: object
                      properties:
                        email:
                          type: string
                        usage_bytes:
                          type: integer
                          format: int64
                  top_messages:
                    type: array
                    items:
                      type: object
                      properties:
                        sender:
                          type: string
                        subject:
                          type: string
                        size_bytes:
                          type: integer
                        filenames:
                          type: array
                          items:
                            type: string
                        queued_at:
                          type: string
                          format: date-time
                  generated_at:
                    type: string
                    format: date-time
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/domains/status:
    get:
      tags:
      - Dashboard
      operationId: getDomainsStatus
      x-required-scope: tenant:read
      summary: Domain health status for the dashboard
      responses:
        '200':
          description: Domain health status
          content:
            application/json:
              schema:
                type: object
                properties:
                  domains:
                    type: array
                    items:
                      type: object
                      properties:
                        domain:
                          type: string
                        verified:
                          type: boolean
                        checks:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              label:
                                type: string
                              status:
                                type: string
                                enum:
                                - healthy
                                - warning
                                - critical
                  generated_at:
                    type: string
                    format: date-time
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
  /v1/health:
    get:
      tags:
      - Dashboard
      operationId: getTenantHealth
      x-required-scope: tenant:read
      summary: Full tenant health report
      responses:
        '200':
          description: Full tenant health report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantHealthReport'
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '403':
          $ref: '#/components/responses/ProblemForbidden'
components:
  schemas:
    TenantHealthReport:
      type: object
      description: The workspace health snapshot behind the console dashboard. DNS checks are live lookups, so a domain whose DNS cannot be read shows as a warning rather than an error.
      required:
      - overall_score
      - checks
      - generated_at
      properties:
        overall_score:
          type: integer
          minimum: 0
          maximum: 100
        checks:
          type: array
          items:
            $ref: '#/components/schemas/TenantHealthCheck'
        generated_at:
          type: string
          format: date-time
    TenantHealthCheck:
      type: object
      required:
      - key
      - label
      - status
      - detail
      properties:
        key:
          type: string
          description: Stable identifier, today one of `domain_verification`, `smtp`, `storage`, `security`. Treat unknown keys as new checks, not errors.
        label:
          type: string
          description: Human-readable name for display.
        status:
          type: string
          description: '`healthy`, `warning` or `critical`.'
        detail:
          type: string
    UserEvent:
      type: object
      properties:
        email:
          type: string
        event_at:
          type: string
          format: date-time
        days_inactive:
          type: integer
          nullable: true
    AuditEvent:
      type: object
      properties:
        email:
          type: string
        event_type:
          type: string
        detail:
          type: string
          nullable: true
        ip:
          type: string
          nullable: true
        time:
          type: string
          format: date-time
    Problem:
      description: RFC 9457 problem-details document.
      type: object
      required:
      - type
      - status
      - title
      properties:
        type:
          type: string
          format: uri
          default: about:blank
        status:
          type: integer
        title:
          type: string
        detail:
          type: string
        instance:
          type: string
          format: uri
  responses:
    ProblemForbidden:
      description: API key lacks the required scope.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProblemUnauthorized:
      description: Missing, malformed, or invalid API key.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: lk_live_<prefix>_<secret>
      description: API key, format `lk_live_<8-char-prefix>_<32-char-secret>`.
    oauth2:
      type: oauth2
      description: 'OAuth 2.1 (authorization code + PKCE). The access token is sent as the

        `Authorization: Bearer` credential, exactly like an API key, so any SDK

        that accepts a bearer token works with OAuth. Discovery:

        `/.well-known/oauth-authorization-server`.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://api.lockally.com/oauth/authorize
          tokenUrl: https://api.lockally.com/oauth/token
          scopes:
            inboxes:read: Read agent-accessible mailboxes and threads
            inboxes:write: Send and act on agent-accessible mailboxes