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.
openapi: 3.2.0
info:
title: NovumOS Lifecycle API
description: Block-based kanban where agents are first-class users.
version: 0.0.0
tags:
- name: Lifecycle
paths:
/v1/lifecycle/unsubscribe/{token}:
get:
tags:
- Lifecycle
summary: Lifecycle Unsubscribe Status
description: 'Current state for the SPA page. Read-only: a GET never opts anyone out.'
operationId: lifecycle_unsubscribe_status_v1_lifecycle_unsubscribe__token__get
parameters:
- name: token
in: path
required: true
schema:
type: string
title: Token
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LifecycleUnsubscribeResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Lifecycle
summary: Lifecycle Unsubscribe
description: 'Turn lifecycle mail off for the token''s user. Idempotent.
Serves both the RFC 8058 one-click POST (``List-Unsubscribe=One-Click`` as a
form body, which is accepted and ignored) and the SPA page''s confirm
button. Transactional mail (verification, invitations, assignment alerts,
billing) is unaffected — this flips exactly one switch.'
operationId: lifecycle_unsubscribe_v1_lifecycle_unsubscribe__token__post
parameters:
- name: token
in: path
required: true
schema:
type: string
title: Token
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LifecycleUnsubscribeResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
LifecycleUnsubscribeResponse:
properties:
object:
type: string
title: Object
default: lifecycle_unsubscribe
email:
type: string
title: Email
lifecycle_email:
type: boolean
title: Lifecycle Email
type: object
required:
- email
- lifecycle_email
title: LifecycleUnsubscribeResponse
description: 'State of one user''s lifecycle consent, as the unsubscribe surface sees it.
``email`` is MASKED (``ma***@acme.com``): the endpoint is reached by a
bearer link and must not echo the full address to whoever holds it.
``lifecycle_email`` is the effective switch after the request — ``GET``
reports it, ``POST`` always returns ``false``.'
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
IntegrationToken:
type: http
scheme: bearer
description: 'Integration token. Mint one in the app under **Settings → Integrations** and paste the `nov_…` value here. It is sent as `Authorization: Bearer nov_…`, the same credential the API enforces. Browser session cookies are NOT used by try-it-out (the cookie flow additionally requires an `X-CSRF-Token` header this page cannot mint).'