Lockally · Schema

APIKey

EmailSoftware-as-a-ServiceNigeriaBusiness

Properties

Name Type Description
id string
tenant_id string
prefix string 8-char public prefix; safe to store and display.
scopes array
label string
last_used_at stringnull
revoked_at stringnull
created_at string
test boolean True for an lk_test_* key: the whole request path runs but a send never reaches the mail server and nothing counts against the account.
expires_at stringnull When the key stops authenticating. Null means it does not expire, which is how every key behaved before expiry existed. Enforced at authentication, so the key fails the first request after this moment
rotated_to stringnull The successor issued by `POST /v1/api-keys/{id}/rotate`. Set on the PREDECESSOR, so you can see which key replaced this one while both still work through the overlap window.
View JSON Schema on GitHub

JSON Schema

lockally-com-apikey-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/lockally-com/json-schema/lockally-com-apikey-schema.json",
  "title": "APIKey",
  "x-generated": "2026-11-17",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lockally-com-openapi.yml#/components/schemas/APIKey",
  "type": "object",
  "required": [
    "id",
    "tenant_id",
    "prefix",
    "scopes",
    "label",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "tenant_id": {
      "type": "string",
      "format": "uuid"
    },
    "prefix": {
      "type": "string",
      "description": "8-char public prefix; safe to store and display."
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "label": {
      "type": "string"
    },
    "last_used_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "revoked_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "test": {
      "type": "boolean",
      "description": "True for an lk_test_* key: the whole request path runs but a send never reaches the mail server and nothing counts against the account."
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the key stops authenticating. Null means it does not expire,\nwhich is how every key behaved before expiry existed. Enforced at\nauthentication, so the key fails the first request after this\nmoment rather than whenever a sweep runs.\n"
    },
    "rotated_to": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The successor issued by `POST /v1/api-keys/{id}/rotate`. Set on the\nPREDECESSOR, so you can see which key replaced this one while both\nstill work through the overlap window.\n"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/lockally-com-apikey"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.