Lockally Signup API
Self-serve tenant registration (public, no auth)
Self-serve tenant registration (public, no auth)
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/lockally-com:lockally-com-signup-api"
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.
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: 3.2.0
info:
title: lockally control plane Signup 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: Signup
description: Self-serve tenant registration (public, no auth)
paths:
/v1/signup:
post:
tags:
- Signup
summary: Sign up a new tenant
operationId: signup
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- slug
- admin_email
- password
properties:
slug:
type: string
description: Workspace id. 3 to 63 characters of lowercase a-z, 0-9 and hyphens, starting and ending with a letter or digit. Anything else is refused with 400 Invalid workspace id.
display_name:
type: string
admin_email:
type: string
format: email
password:
type: string
minLength: 12
mode:
type: string
enum:
- api
- business
- both
default: business
responses:
'201':
description: Tenant created with initial admin and API token.
content:
application/json:
schema:
type: object
required:
- token
- expires_at
- admin
- tenant
properties:
token:
type: string
expires_at:
type: string
format: date-time
admin:
$ref: '#/components/schemas/Admin'
tenant:
$ref: '#/components/schemas/Tenant'
'400':
$ref: '#/components/responses/ProblemBadRequest'
'409':
description: Slug or email already taken.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
components:
schemas:
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
Tenant:
type: object
required:
- id
- slug
- display_name
- status
- plan
- rate_cap_per_min
- daily_msg_quota
- admin_email
- created_at
properties:
id:
type: string
format: uuid
slug:
type: string
example: workgrid
display_name:
type: string
example: WorkGrid
status:
type: string
enum:
- active
- suspended
- closing
- closed
plan:
type: string
example: starter
rate_cap_per_min:
type: integer
description: Per-tenant share of the per-VPS 5/min outbound cap (L6).
example: 1
daily_msg_quota:
type: integer
example: 1000
admin_email:
type: string
format: email
created_at:
type: string
format: date-time
suspended_at:
type: string
format: date-time
nullable: true
closed_at:
type: string
format: date-time
nullable: true
hard_delete_after:
type: string
format: date-time
nullable: true
Admin:
type: object
required:
- id
- tenant_id
- email
- role
- created_at
properties:
id:
type: string
format: uuid
tenant_id:
type: string
format: uuid
email:
type: string
format: email
display_name:
type: string
role:
type: string
enum:
- admin
- viewer
last_login_at:
type: string
format: date-time
nullable: true
created_at:
type: string
format: date-time
responses:
ProblemBadRequest:
description: Malformed request.
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