API and MCP reference

Everything the app does is one of these 521 operations, with the caller's permissions. The web app, the REST API, the MCP server, thekb CLI and the SDKs all come from the same contract, so this page is always complete.

Calling an operation

POST /api/v1/<op> with a JSON body and authorization: Bearer kb_…. Create keys in Settings → API keys: personal tokens act as you; agent keys act for you and show up as via agent:name in history. A key never gets more than its owner's role.

Errors are application/problem+json (RFC 9457) whose detail says what to fix. Writes take Idempotency-Key (24 h replay); reads answer with an ETag (send If-None-Match for a 304). Every answer carries x-kb-seq, the org's change sequence.

Changes, batches, streams

api.batch runs up to 50 operations in one transaction. api.changes {since} pages through every event since a sequence number; GET /api/v1/stream is the same as server-sent events, resumable with Last-Event-ID. Webhooks deliver events signed with HMAC.

Machine calls (API keys, agents, automation) count toward the Free plan's monthly allowance; people clicking in the app never do.

MCP

Point Claude or any MCP client at https://work.nightroll.app/mcp (Streamable HTTP) with the same header. Each operation below is a tool named module_verb, annotated read-only or destructive; destructive tools need confirm: true, which clients ask you for.

claude mcp add --transport http work https://work.nightroll.app/mcp \
  --header "Authorization: Bearer kb_…"

CLI and SDKs

One dependency-free Python file is both the SDK and the kb CLI: sign in with a device code, then run any operation or TQL.

curl -fsSLo kb https://work.nightroll.app/sdk/work.py && chmod +x kb
./kb login
./kb tql "assignee = currentUser() AND statusCategory != Done"
./kb issues.create project=WEB title="Fix login"

TypeScript: work.ts with schema.d.ts, typed from the contract (new Nightroll Work({token}).issues.create(…)).

VS Code

Install nightroll-work.vsix (Extensions → ⋯ → Install from VSIX) and run Work: Sign in: you approve a code in the browser, like the CLI. The Nightroll Work view lists your issues (any TQL, in settings); open one as a preview with its comments, create one from the selected code (file and line quoted), move it through the workflow, and create its branch from your branch template. The status bar shows the issue the current branch is for.

activity

activity.listread

REST POST /api/v1/activity.list · MCP tool activity_list · scopes activity:read

Input

`since`	`integer`	Only events after this sequence number (e.g. `previous.seq` from `activity.seen`).
`subject`required	`string`	`kind:id`, e.g. "issue:12" or "page:ab12…".

Output `object[]`

`actor`	`string`
`actor_kind`	`string`	human \| key \| agent \| system \| automation
`created_at`	`integer`
`kind`	`string`	Event kind, e.g. "issue.updated", "comment.created".
`payload`	`any`	Event payload as emitted (changed fields are `{from, to}`).
`seq`	`integer`
`subject`	`string`
`title`	`string`	The subject's current title, if it still exists and is viewable.
`via`	`string`	What a machine actor came through, e.g. `agent:claude`.

curl https://work.nightroll.app/api/v1/activity.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>"}'

activity.recentread

REST POST /api/v1/activity.recent · MCP tool activity_recent · scopes activity:read

Input

limit integer Default 30, max 100.

Output `object[]`

`actor`	`string`
`actor_kind`	`string`	human \| key \| agent \| system \| automation
`created_at`	`integer`
`kind`	`string`	Event kind, e.g. "issue.updated", "comment.created".
`payload`	`any`	Event payload as emitted (changed fields are `{from, to}`).
`seq`	`integer`
`subject`	`string`
`title`	`string`	The subject's current title, if it still exists and is viewable.
`via`	`string`	What a machine actor came through, e.g. `agent:claude`.

curl https://work.nightroll.app/api/v1/activity.recent \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

activity.seenread

REST POST /api/v1/activity.seen · MCP tool activity_seen · scopes activity:read

Input

subjectrequired string

Output `object`

`changes`	`integer`	Events by other people since then.
`previous`	`object`	When you last looked before now; null the first time.

curl https://work.nightroll.app/api/v1/activity.seen \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>"}'

ai

ai.allowedread

REST POST /api/v1/ai.allowed · MCP tool ai_allowed · scopes ai:read

Input

subjectsrequired string[]

Output `object[]`

`allowed`	`boolean`
`reason`	`string`	Why not (excluded by policy, or AI is off).
`subject`	`string`

curl https://work.nightroll.app/api/v1/ai.allowed \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subjects":[]}'

ai.completewrite

REST POST /api/v1/ai.complete · MCP tool ai_complete · scopes ai:write

Input

`feature`required	`string`	What this is for (assistant, summary, triage, test…); usage is grouped by it.
`max_tokens`	`integer`	Longest answer (default 1024, at most 8192).
`messages`required	`object[]`
`model`	`string`	Must be one of the provider's models; default: its default model.
`provider`	`string`	Provider id; default: the first enabled one with a key.
`subjects`	`string[]`	What the prompt contains: the caller must see each, and none may be excluded from AI.
`system`	`string`

Output `object`

`input_tokens`	`integer`
`model`	`string`
`output_tokens`	`integer`
`provider`	`string`
`text`	`string`

curl https://work.nightroll.app/api/v1/ai.complete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"feature":"<feature>","messages":[]}'

ai.contextread

REST POST /api/v1/ai.context · MCP tool ai_context · scopes ai:read

Input

`mode`	`string`	summary (default) \| changes (what happened after `since`) \| explain (rewritten for `profile`)
`profile`	`string`	For `explain`: a reader profile key (`ai.profiles`).
`since`	`integer`	For `changes`: an outbox sequence number (`previous.seq` from `activity.seen`).
`subject`required	`string`	`issue:12`, `page:…`, `sprint:3`, or any indexed subject.

Output `object`

`feature`	`string`	summary \| changes: the `feature` to pass to `ai.complete`.
`material`	`string`	The subject's material alone (JSON text), for callers writing their own prompt.
`prompt`	`string`
`subject`	`string`
`system`	`string`	Ready to send: the system prompt and the user message (the subject's material inside).
`title`	`string`

curl https://work.nightroll.app/api/v1/ai.context \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>"}'

ai.explainwrite

REST POST /api/v1/ai.explain · MCP tool ai_explain · scopes ai:write

Input

`model`	`string`
`profile`required	`string`	A reader profile key (`ai.profiles`).
`provider`	`string`
`subject`required	`string`

Output `object`

`model`	`string`
`provider`	`string`
`text`	`string`

curl https://work.nightroll.app/api/v1/ai.explain \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"profile":"<profile>","subject":"<subject>"}'

ai.key_revokedestructive

REST POST /api/v1/ai.key_revoke · MCP tool ai_key_revoke · scopes admin

Input

idrequired string

Output `object`

`automation_apply`	`boolean`	AI automation steps marked "apply" may change things without review (otherwise they only propose).
`browser_keys`	`boolean`	People may use their own provider keys, kept in their browser and never sent to us.
`enabled`	`boolean`	AI features are on for this org.
`excluded`	`string[]`	Subjects AI never reads, with everything inside them (`space:ENG`, `project:WEB`, `page:…`, `issue:12`).
`member_daily_tokens`	`integer`	Org-key tokens one member may use per day (UTC); null = no cap.
`monthly_tokens`	`integer`	Org-key tokens allowed per calendar month (UTC); null = no cap.
`org_keys`	`boolean`	AI features may run on the org's stored keys (digests, automations, summaries for everyone).
`providers`	`object[]`
`used_month`	`integer`	Org-key tokens used this month by everyone, and today by you.
`used_today`	`integer`

curl https://work.nightroll.app/api/v1/ai.key_revoke \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

ai.key_setwrite

REST POST /api/v1/ai.key_set · MCP tool ai_key_set · scopes admin

Input

`label`	`string`
`provider`required	`string`
`secret`required	`string`	The provider's API key. Stored encrypted; never shown again.

Output `object`

`automation_apply`	`boolean`	AI automation steps marked "apply" may change things without review (otherwise they only propose).
`browser_keys`	`boolean`	People may use their own provider keys, kept in their browser and never sent to us.
`enabled`	`boolean`	AI features are on for this org.
`excluded`	`string[]`	Subjects AI never reads, with everything inside them (`space:ENG`, `project:WEB`, `page:…`, `issue:12`).
`member_daily_tokens`	`integer`	Org-key tokens one member may use per day (UTC); null = no cap.
`monthly_tokens`	`integer`	Org-key tokens allowed per calendar month (UTC); null = no cap.
`org_keys`	`boolean`	AI features may run on the org's stored keys (digests, automations, summaries for everyone).
`providers`	`object[]`
`used_month`	`integer`	Org-key tokens used this month by everyone, and today by you.
`used_today`	`integer`

curl https://work.nightroll.app/api/v1/ai.key_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"provider":"<provider>","secret":"<secret>"}'

ai.policyread

REST POST /api/v1/ai.policy · MCP tool ai_policy · scopes ai:read

Input

None: send {}.

Output `object`

`automation_apply`	`boolean`	AI automation steps marked "apply" may change things without review (otherwise they only propose).
`browser_keys`	`boolean`	People may use their own provider keys, kept in their browser and never sent to us.
`enabled`	`boolean`	AI features are on for this org.
`excluded`	`string[]`	Subjects AI never reads, with everything inside them (`space:ENG`, `project:WEB`, `page:…`, `issue:12`).
`member_daily_tokens`	`integer`	Org-key tokens one member may use per day (UTC); null = no cap.
`monthly_tokens`	`integer`	Org-key tokens allowed per calendar month (UTC); null = no cap.
`org_keys`	`boolean`	AI features may run on the org's stored keys (digests, automations, summaries for everyone).
`providers`	`object[]`
`used_month`	`integer`	Org-key tokens used this month by everyone, and today by you.
`used_today`	`integer`

curl https://work.nightroll.app/api/v1/ai.policy \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

ai.policy_setwrite

REST POST /api/v1/ai.policy_set · MCP tool ai_policy_set · scopes admin

Input

`automation_apply`	`boolean`	Default false.
`browser_keys`required	`boolean`
`enabled`required	`boolean`
`excluded`required	`string[]`
`member_daily_tokens`	`integer`
`monthly_tokens`	`integer`
`org_keys`required	`boolean`

Output `object`

`automation_apply`	`boolean`	AI automation steps marked "apply" may change things without review (otherwise they only propose).
`browser_keys`	`boolean`	People may use their own provider keys, kept in their browser and never sent to us.
`enabled`	`boolean`	AI features are on for this org.
`excluded`	`string[]`	Subjects AI never reads, with everything inside them (`space:ENG`, `project:WEB`, `page:…`, `issue:12`).
`member_daily_tokens`	`integer`	Org-key tokens one member may use per day (UTC); null = no cap.
`monthly_tokens`	`integer`	Org-key tokens allowed per calendar month (UTC); null = no cap.
`org_keys`	`boolean`	AI features may run on the org's stored keys (digests, automations, summaries for everyone).
`providers`	`object[]`
`used_month`	`integer`	Org-key tokens used this month by everyone, and today by you.
`used_today`	`integer`

curl https://work.nightroll.app/api/v1/ai.policy_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"browser_keys":true,"enabled":true,"excluded":[],"org_keys":true}'

ai.profile_deletedestructive

REST POST /api/v1/ai.profile_delete · MCP tool ai_profile_delete · scopes admin

Input

idrequired string

Output `object[]`

`instructions`	`string`	How to write for them.
`key`	`string`
`label`	`string`

curl https://work.nightroll.app/api/v1/ai.profile_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

ai.profile_savewrite

REST POST /api/v1/ai.profile_save · MCP tool ai_profile_save · scopes admin

Input

`instructions`required	`string`
`key`required	`string`	Lowercase letters, digits and `-`.
`label`required	`string`

Output `object[]`

`instructions`	`string`	How to write for them.
`key`	`string`
`label`	`string`

curl https://work.nightroll.app/api/v1/ai.profile_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"instructions":"<instructions>","key":"<key>","label":"<label>"}'

ai.profilesread

REST POST /api/v1/ai.profiles · MCP tool ai_profiles · scopes ai:read

Input

None: send {}.

Output `object[]`

`instructions`	`string`	How to write for them.
`key`	`string`
`label`	`string`

curl https://work.nightroll.app/api/v1/ai.profiles \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

ai.proposal_applywrite

REST POST /api/v1/ai.proposal_apply · MCP tool ai_proposal_apply · scopes ai:write

Input

idrequired integer

Output `object`

`answer`	`string`	The model's answer.
`created_at`	`integer`
`decided_at`	`integer`
`decided_by`	`string`
`error`	`string`
`id`	`integer`
`input`	`any`
`op`	`string`	What applying runs.
`rule`	`string`	The automation rule that asked, by name.
`state`	`string`	open \| applied \| dismissed \| failed
`subject`	`string`
`task`	`string`
`title`	`string`	The subject's title now.

curl https://work.nightroll.app/api/v1/ai.proposal_apply \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

ai.proposal_dismisswrite

REST POST /api/v1/ai.proposal_dismiss · MCP tool ai_proposal_dismiss · scopes ai:write

Input

idrequired integer

Output `object`

`answer`	`string`	The model's answer.
`created_at`	`integer`
`decided_at`	`integer`
`decided_by`	`string`
`error`	`string`
`id`	`integer`
`input`	`any`
`op`	`string`	What applying runs.
`rule`	`string`	The automation rule that asked, by name.
`state`	`string`	open \| applied \| dismissed \| failed
`subject`	`string`
`task`	`string`
`title`	`string`	The subject's title now.

curl https://work.nightroll.app/api/v1/ai.proposal_dismiss \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

ai.proposalsread

REST POST /api/v1/ai.proposals · MCP tool ai_proposals · scopes ai:read

Input

`state`	`string`	Default open.
`subject`	`string`

Output `object[]`

`answer`	`string`	The model's answer.
`created_at`	`integer`
`decided_at`	`integer`
`decided_by`	`string`
`error`	`string`
`id`	`integer`
`input`	`any`
`op`	`string`	What applying runs.
`rule`	`string`	The automation rule that asked, by name.
`state`	`string`	open \| applied \| dismissed \| failed
`subject`	`string`
`task`	`string`
`title`	`string`	The subject's title now.

curl https://work.nightroll.app/api/v1/ai.proposals \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

ai.provider_deletedestructive

REST POST /api/v1/ai.provider_delete · MCP tool ai_provider_delete · scopes admin

Input

idrequired string

Output `object`

`automation_apply`	`boolean`	AI automation steps marked "apply" may change things without review (otherwise they only propose).
`browser_keys`	`boolean`	People may use their own provider keys, kept in their browser and never sent to us.
`enabled`	`boolean`	AI features are on for this org.
`excluded`	`string[]`	Subjects AI never reads, with everything inside them (`space:ENG`, `project:WEB`, `page:…`, `issue:12`).
`member_daily_tokens`	`integer`	Org-key tokens one member may use per day (UTC); null = no cap.
`monthly_tokens`	`integer`	Org-key tokens allowed per calendar month (UTC); null = no cap.
`org_keys`	`boolean`	AI features may run on the org's stored keys (digests, automations, summaries for everyone).
`providers`	`object[]`
`used_month`	`integer`	Org-key tokens used this month by everyone, and today by you.
`used_today`	`integer`

curl https://work.nightroll.app/api/v1/ai.provider_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

ai.provider_modelswrite

REST POST /api/v1/ai.provider_models · MCP tool ai_provider_models · scopes admin

Input

idrequired string

Output `object`

`models`	`object[]`	Everything the provider lists, plus allowed models it no longer lists (so they can be removed).
`provider`	`string`

curl https://work.nightroll.app/api/v1/ai.provider_models \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

ai.provider_savewrite

REST POST /api/v1/ai.provider_save · MCP tool ai_provider_save · scopes admin

Input

`base_url`required	`string`	http(s) base, e.g. https://api.anthropic.com
`browser`required	`boolean`
`default_model`required	`string`
`enabled`required	`boolean`
`id`required	`string`	Lowercase letters, digits and `-`.
`kind`required	`string`	anthropic \| openai
`label`required	`string`
`models`required	`string[]`
`needs_key`required	`boolean`

Output `object`

`automation_apply`	`boolean`	AI automation steps marked "apply" may change things without review (otherwise they only propose).
`browser_keys`	`boolean`	People may use their own provider keys, kept in their browser and never sent to us.
`enabled`	`boolean`	AI features are on for this org.
`excluded`	`string[]`	Subjects AI never reads, with everything inside them (`space:ENG`, `project:WEB`, `page:…`, `issue:12`).
`member_daily_tokens`	`integer`	Org-key tokens one member may use per day (UTC); null = no cap.
`monthly_tokens`	`integer`	Org-key tokens allowed per calendar month (UTC); null = no cap.
`org_keys`	`boolean`	AI features may run on the org's stored keys (digests, automations, summaries for everyone).
`providers`	`object[]`
`used_month`	`integer`	Org-key tokens used this month by everyone, and today by you.
`used_today`	`integer`

curl https://work.nightroll.app/api/v1/ai.provider_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"base_url":"<base_url>","browser":true,"default_model":"<default_model>","enabled":true,"id":"<id>","kind":"<kind>","label":"<label>","models":[],"needs_key":true}'

ai.runwrite

REST POST /api/v1/ai.run · MCP tool ai_run · scopes ai:write

Input

`apply`	`boolean`	Apply without review, if the org's AI policy allows automation to (otherwise it's proposed).
`instructions`	`string`	Extra guidance (or, for `prompt`, the whole ask).
`options`	`any`	For classify: the choices, as a list or comma-separated text.
`rule`	`string`	The automation rule asking (`{{rule}}`, its name), for the record.
`subject`required	`string`	What it's about: `issue:12`, `page:…`.
`task`required	`string`	classify (pick one of `options`) \| summarize \| draft_reply \| prompt (follow `instructions`)
`then`	`object`	What to do with the answer. Default for summarize/draft_reply/prompt: a comment on the subject.

Output `object`

job integer

curl https://work.nightroll.app/api/v1/ai.run \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>","task":"<task>"}'

ai.summarizewrite

REST POST /api/v1/ai.summarize · MCP tool ai_summarize · scopes ai:write

Input

`mode`	`string`	summary (default) \| changes
`model`	`string`
`provider`	`string`
`since`	`integer`
`subject`required	`string`

Output `object`

`model`	`string`
`provider`	`string`
`summary`	`string`

curl https://work.nightroll.app/api/v1/ai.summarize \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>"}'

ai.usagewrite

REST POST /api/v1/ai.usage · MCP tool ai_usage · scopes admin

Input

days integer Look back this many days (1-366, default 30).

Output `object[]`

`actor`	`string`
`calls`	`integer`
`errors`	`integer`
`feature`	`string`
`input_tokens`	`integer`
`model`	`string`
`output_tokens`	`integer`
`provider`	`string`

curl https://work.nightroll.app/api/v1/ai.usage \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

analytics

analytics.exportwrite

REST POST /api/v1/analytics.export · MCP tool analytics_export · scopes admin

Input

`format`required	`string`	ndjson \| parquet
`from`required	`string`	First day, `YYYY-MM-DD` (UTC).
`to`required	`string`	Last day, inclusive.

Output `object`

`data`	`string`	The file, base64.
`events`	`integer`
`name`	`string`
`truncated`	`boolean`	More events in the range than one file holds: export a shorter range.

curl https://work.nightroll.app/api/v1/analytics.export \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"format":"<format>","from":"<from>","to":"<to>"}'

analytics.querywrite

REST POST /api/v1/analytics.query · MCP tool analytics_query · scopes admin

Input

sqlrequired string One SELECT over `events(seq, kind, subject, actor, actor_kind, via, at, payload)`; `at` is Unix seconds, `payload` JSON (use json_extract).

Output `object`

`columns`	`string[]`
`ms`	`integer`
`rows`	`any[][]`
`truncated`	`boolean`	More rows matched than came back.

curl https://work.nightroll.app/api/v1/analytics.query \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"sql":"<sql>"}'

analytics.report_deletedestructive

REST POST /api/v1/analytics.report_delete · MCP tool analytics_report_delete · scopes admin

Input

idrequired integer

Output `any`

curl https://work.nightroll.app/api/v1/analytics.report_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

analytics.report_runwrite

REST POST /api/v1/analytics.report_run · MCP tool analytics_report_run · scopes admin

Input

idrequired integer

Output `object`

`created_by`	`string`
`every`	`string`	manual \| daily \| weekly \| monthly
`id`	`integer`
`last_error`	`string`
`last_result`	`any`	The first rows of the last run.
`last_rows`	`integer`
`last_run_at`	`integer`
`name`	`string`
`next_run_at`	`integer`
`recipients`	`string[]`	Identity ids or `team:<id>` / `team:admins` told when it runs (admins only see it).
`sql`	`string`

curl https://work.nightroll.app/api/v1/analytics.report_run \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

analytics.report_savewrite

REST POST /api/v1/analytics.report_save · MCP tool analytics_report_save · scopes admin

Input

`every`required	`string`	manual \| daily \| weekly \| monthly
`id`	`integer`
`name`required	`string`
`recipients`	`string[]`
`sql`required	`string`

Output `object`

`created_by`	`string`
`every`	`string`	manual \| daily \| weekly \| monthly
`id`	`integer`
`last_error`	`string`
`last_result`	`any`	The first rows of the last run.
`last_rows`	`integer`
`last_run_at`	`integer`
`name`	`string`
`next_run_at`	`integer`
`recipients`	`string[]`	Identity ids or `team:<id>` / `team:admins` told when it runs (admins only see it).
`sql`	`string`

curl https://work.nightroll.app/api/v1/analytics.report_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"every":"<every>","name":"<name>","sql":"<sql>"}'

analytics.reportswrite

REST POST /api/v1/analytics.reports · MCP tool analytics_reports · scopes admin

Input

None: send {}.

Output `object[]`

`created_by`	`string`
`every`	`string`	manual \| daily \| weekly \| monthly
`id`	`integer`
`last_error`	`string`
`last_result`	`any`	The first rows of the last run.
`last_rows`	`integer`
`last_run_at`	`integer`
`name`	`string`
`next_run_at`	`integer`
`recipients`	`string[]`	Identity ids or `team:<id>` / `team:admins` told when it runs (admins only see it).
`sql`	`string`

curl https://work.nightroll.app/api/v1/analytics.reports \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

api

api.batchwriteRuns up to 50 ops in order in one transaction: all of them commit, or (on the first error) none do.

REST POST /api/v1/api.batch · MCP tool api_batch · scopes api:read | api:write

Input

opsrequired object[]

Output `object`

results any[] Each op's output, in order.

curl https://work.nightroll.app/api/v1/api.batch \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"ops":[]}'

api.changesreadEvents after `since` that the caller can see, oldest first. Poll with `since = next` (or use the event stream).

REST POST /api/v1/api.changes · MCP tool api_changes · scopes api:read

Input

`limit`	`integer`	Events to scan, 1-500 (default 100).
`since`	`integer`	A sequence number from `next`, an `x-kb-seq` header or an event; 0 = from the beginning.

Output `object`

`events`	`object[]`
`more`	`boolean`	More events are waiting: call again right away.
`next`	`integer`	Pass as `since` next time (it also skips events you can't see).

curl https://work.nightroll.app/api/v1/api.changes \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

approvals

approvals.cancelwrite

REST POST /api/v1/approvals.cancel · MCP tool approvals_cancel · scopes issues:write

Input

idrequired integer

Output `object`

`approvals`	`integer`
`approvers`	`string[]`
`can_decide`	`boolean`	The caller may approve or reject it now.
`created_at`	`integer`
`decided_at`	`integer`
`id`	`integer`
`key`	`string`
`needed`	`integer`
`note`	`string`
`requested_by`	`string`
`state`	`string`	pending \| approved (move it) \| rejected \| cancelled \| done (moved)
`title`	`string`
`to_status`	`string`
`transition`	`string`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/approvals.cancel \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

approvals.decidewrite

REST POST /api/v1/approvals.decide · MCP tool approvals_decide · scopes issues:write

Input

`approve`required	`boolean`
`id`required	`integer`
`note`	`string`

Output `object`

`blocked`	`string`	Why it couldn't move yet (the requester can move it once that's fixed).
`moved`	`boolean`	The issue moved now (approved and nothing stopped it).
`request`	`object`

curl https://work.nightroll.app/api/v1/approvals.decide \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"approve":true,"id":1}'

approvals.listread

REST POST /api/v1/approvals.list · MCP tool approvals_list · scopes issues:read

Input

keyrequired string

Output `object[]`

`approvals`	`integer`
`approvers`	`string[]`
`can_decide`	`boolean`	The caller may approve or reject it now.
`created_at`	`integer`
`decided_at`	`integer`
`id`	`integer`
`key`	`string`
`needed`	`integer`
`note`	`string`
`requested_by`	`string`
`state`	`string`	pending \| approved (move it) \| rejected \| cancelled \| done (moved)
`title`	`string`
`to_status`	`string`
`transition`	`string`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/approvals.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

approvals.mineread

REST POST /api/v1/approvals.mine · MCP tool approvals_mine · scopes issues:read

Input

None: send {}.

Output `object[]`

`approvals`	`integer`
`approvers`	`string[]`
`can_decide`	`boolean`	The caller may approve or reject it now.
`created_at`	`integer`
`decided_at`	`integer`
`id`	`integer`
`key`	`string`
`needed`	`integer`
`note`	`string`
`requested_by`	`string`
`state`	`string`	pending \| approved (move it) \| rejected \| cancelled \| done (moved)
`title`	`string`
`to_status`	`string`
`transition`	`string`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/approvals.mine \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

approvals.requestwrite

REST POST /api/v1/approvals.request · MCP tool approvals_request · scopes issues:write

Input

`key`required	`string`
`note`	`string`
`to_status`required	`string`	The status to move to (a transition with approvers).

Output `object`

`approvals`	`integer`
`approvers`	`string[]`
`can_decide`	`boolean`	The caller may approve or reject it now.
`created_at`	`integer`
`decided_at`	`integer`
`id`	`integer`
`key`	`string`
`needed`	`integer`
`note`	`string`
`requested_by`	`string`
`state`	`string`	pending \| approved (move it) \| rejected \| cancelled \| done (moved)
`title`	`string`
`to_status`	`string`
`transition`	`string`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/approvals.request \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","to_status":"<to_status>"}'

assets

assets.createwrite

REST POST /api/v1/assets.create · MCP tool assets_create · scopes assets:write

Input

`name`required	`string`
`owner`	`string`
`status`	`string`
`type`required	`string`
`values`	`object`

Output `object`

`created_at`	`integer`
`created_by`	`string`
`id`	`integer`
`issues`	`string[]`	Linked issue keys.
`key`	`string`	LAPTOP-12
`name`	`string`
`owner`	`string`	Member id.
`status`	`string`	active \| maintenance \| retired
`type`	`string`
`updated_at`	`integer`
`values`	`object`	Field values by key (references hold asset keys).

curl https://work.nightroll.app/api/v1/assets.create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","type":"<type>"}'

assets.deletedestructive

REST POST /api/v1/assets.delete · MCP tool assets_delete · scopes assets:write

Input

keyrequired string Asset key (LAPTOP-12) or id.

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/assets.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

assets.for_issueread

REST POST /api/v1/assets.for_issue · MCP tool assets_for_issue · scopes assets:read

Input

issuerequired string

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`id`	`integer`
`issues`	`string[]`	Linked issue keys.
`key`	`string`	LAPTOP-12
`name`	`string`
`owner`	`string`	Member id.
`status`	`string`	active \| maintenance \| retired
`type`	`string`
`updated_at`	`integer`
`values`	`object`	Field values by key (references hold asset keys).

curl https://work.nightroll.app/api/v1/assets.for_issue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"issue":"<issue>"}'

assets.getread

REST POST /api/v1/assets.get · MCP tool assets_get · scopes assets:read

Input

keyrequired string Asset key (LAPTOP-12) or id.

Output `object`

`created_at`	`integer`
`created_by`	`string`
`id`	`integer`
`issues`	`string[]`	Linked issue keys.
`key`	`string`	LAPTOP-12
`name`	`string`
`owner`	`string`	Member id.
`status`	`string`	active \| maintenance \| retired
`type`	`string`
`updated_at`	`integer`
`values`	`object`	Field values by key (references hold asset keys).

curl https://work.nightroll.app/api/v1/assets.get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

assets.linkwrite

REST POST /api/v1/assets.link · MCP tool assets_link · scopes assets:write

Input

`asset`required	`string`	Asset key.
`issue`required	`string`	Issue key.
`linked`	`boolean`

Output `object`

`created_at`	`integer`
`created_by`	`string`
`id`	`integer`
`issues`	`string[]`	Linked issue keys.
`key`	`string`	LAPTOP-12
`name`	`string`
`owner`	`string`	Member id.
`status`	`string`	active \| maintenance \| retired
`type`	`string`
`updated_at`	`integer`
`values`	`object`	Field values by key (references hold asset keys).

curl https://work.nightroll.app/api/v1/assets.link \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"asset":"<asset>","issue":"<issue>"}'

assets.listread

REST POST /api/v1/assets.list · MCP tool assets_list · scopes assets:read

Input

`q`	`string`	Words in the key, name or field values.
`refers_to`	`string`	Assets whose reference fields point at this asset key (what depends on it).
`status`	`string`	active \| maintenance \| retired
`type`	`string`	A type key.

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`id`	`integer`
`issues`	`string[]`	Linked issue keys.
`key`	`string`	LAPTOP-12
`name`	`string`
`owner`	`string`	Member id.
`status`	`string`	active \| maintenance \| retired
`type`	`string`
`updated_at`	`integer`
`values`	`object`	Field values by key (references hold asset keys).

curl https://work.nightroll.app/api/v1/assets.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

assets.type_deletedestructive

REST POST /api/v1/assets.type_delete · MCP tool assets_type_delete · scopes admin

Input

idrequired integer

Output `object[]`

`count`	`integer`
`description`	`string`
`fields`	`object[]`
`icon`	`string`
`id`	`integer`
`key`	`string`	Asset keys start with it: LAPTOP-12.
`name`	`string`
`position`	`number`

curl https://work.nightroll.app/api/v1/assets.type_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

assets.type_savewrite

REST POST /api/v1/assets.type_save · MCP tool assets_type_save · scopes admin

Input

`description`	`string`
`fields`	`object[]`
`icon`	`string`
`id`	`integer`
`key`	`string`	Letters and digits, 2–10, starting with a letter (create only).
`name`required	`string`
`position`	`number`

Output `object[]`

`count`	`integer`
`description`	`string`
`fields`	`object[]`
`icon`	`string`
`id`	`integer`
`key`	`string`	Asset keys start with it: LAPTOP-12.
`name`	`string`
`position`	`number`

curl https://work.nightroll.app/api/v1/assets.type_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>"}'

assets.typesread

REST POST /api/v1/assets.types · MCP tool assets_types · scopes assets:read

Input

None: send {}.

Output `object[]`

`count`	`integer`
`description`	`string`
`fields`	`object[]`
`icon`	`string`
`id`	`integer`
`key`	`string`	Asset keys start with it: LAPTOP-12.
`name`	`string`
`position`	`number`

curl https://work.nightroll.app/api/v1/assets.types \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

assets.updatewrite

REST POST /api/v1/assets.update · MCP tool assets_update · scopes assets:write

Input

`key`required	`string`
`name`	`string`
`owner`	`string`	Member id; empty clears.
`status`	`string`
`values`	`object`	Fields to set (null clears); others unchanged.

Output `object`

`created_at`	`integer`
`created_by`	`string`
`id`	`integer`
`issues`	`string[]`	Linked issue keys.
`key`	`string`	LAPTOP-12
`name`	`string`
`owner`	`string`	Member id.
`status`	`string`	active \| maintenance \| retired
`type`	`string`
`updated_at`	`integer`
`values`	`object`	Field values by key (references hold asset keys).

curl https://work.nightroll.app/api/v1/assets.update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

attachments

attachments.addwrite

REST POST /api/v1/attachments.add · MCP tool attachments_add · scopes attachments:write

Input

`content_type`	`string`
`data`required	`string`	Base64 of the file, 10 MB max.
`name`required	`string`
`subject`required	`string`	What it's attached to, e.g. `issue:42`.

Output `object`

`content_type`	`string`
`created_at`	`integer`
`created_by`	`string`
`id`	`string`
`name`	`string`
`size`	`integer`
`subject`	`string`

curl https://work.nightroll.app/api/v1/attachments.add \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"data":"<data>","name":"<name>","subject":"<subject>"}'

attachments.deletedestructive

REST POST /api/v1/attachments.delete · MCP tool attachments_delete · scopes attachments:write

Input

idrequired string

Output `object`

`content_type`	`string`
`created_at`	`integer`
`created_by`	`string`
`id`	`string`
`name`	`string`
`size`	`integer`
`subject`	`string`

curl https://work.nightroll.app/api/v1/attachments.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

attachments.getread

REST POST /api/v1/attachments.get · MCP tool attachments_get · scopes attachments:read

Input

`as_url`	`boolean`	A download link instead of the bytes, where the deployment serves files from their own origin.
`id`required	`string`

Output `object`

`content_type`	`string`
`data`	`string`	Base64 of the file (empty when `url` is given).
`id`	`string`
`name`	`string`
`url`	`string`	With `as_url`, where the deployment has a files origin: a five-minute link that downloads it.

curl https://work.nightroll.app/api/v1/attachments.get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

attachments.listread

REST POST /api/v1/attachments.list · MCP tool attachments_list · scopes attachments:read

Input

subjectrequired string

Output `object[]`

`content_type`	`string`
`created_at`	`integer`
`created_by`	`string`
`id`	`string`
`name`	`string`
`size`	`integer`
`subject`	`string`

curl https://work.nightroll.app/api/v1/attachments.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>"}'

audit

audit.exportwrite

REST POST /api/v1/audit.export · MCP tool audit_export · scopes admin

Input

`actor`	`string`	Identity id of who acted (or `system`, `anonymous`).
`actor_kind`	`string`	human \| key \| agent \| system \| automation.
`from`	`integer`	Unix seconds, inclusive.
`kind`	`string`	Event kind, e.g. `issue.updated`; a trailing `` matches a prefix (`auth.`).
`q`	`string`	Text anywhere in the subject, via or details.
`subject`	`string`	`kind:id`, e.g. `issue:42`.
`to`	`integer`	Unix seconds, exclusive.

Output `object`

`count`	`integer`
`ndjson`	`string`	One JSON entry per line, oldest first.
`truncated`	`boolean`	True when more than 50,000 entries matched (narrow the dates and export again).

curl https://work.nightroll.app/api/v1/audit.export \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

audit.listwriteNewest first. Page with `before = next_before`.

REST POST /api/v1/audit.list · MCP tool audit_list · scopes admin

Input

`actor`	`string`	Identity id of who acted (or `system`, `anonymous`).
`actor_kind`	`string`	human \| key \| agent \| system \| automation.
`before`	`integer`
`from`	`integer`	Unix seconds, inclusive.
`kind`	`string`	Event kind, e.g. `issue.updated`; a trailing `` matches a prefix (`auth.`).
`limit`	`integer`	1-200, default 50.
`q`	`string`	Text anywhere in the subject, via or details.
`subject`	`string`	`kind:id`, e.g. `issue:42`.
`to`	`integer`	Unix seconds, exclusive.

Output `object`

`entries`	`object[]`
`next_before`	`integer`	Pass as `before` for the next page; null at the end.
`plan`	`string`
`retention_days`	`integer`	Entries older than this many days are deleted.

curl https://work.nightroll.app/api/v1/audit.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

audit.recordwriteRecords a sign-in or membership event that happened in the directory (the cell calls it; not a public op).

REST POST /api/v1/audit.record · MCP tool audit_record · scopes system

Input

`kind`required	`string`
`payload`	`any`
`subject`required	`string`

Output `any`

curl https://work.nightroll.app/api/v1/audit.record \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"kind":"<kind>","subject":"<subject>"}'

automation

automation.catalogread

REST POST /api/v1/automation.catalog · MCP tool automation_catalog · scopes automation:read

Input

None: send {}.

Output `object`

`general`	`object[]`	Presets for any rule (web requests…).
`ops`	`string[]`	Every op an action may run.
`subjects`	`object[]`
`variables`	`object[]`	Variables every rule has besides the subject's fields.

curl https://work.nightroll.app/api/v1/automation.catalog \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

automation.deletedestructive

REST POST /api/v1/automation.delete · MCP tool automation_delete · scopes admin

Input

idrequired integer

Output `any`

curl https://work.nightroll.app/api/v1/automation.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

automation.listread

REST POST /api/v1/automation.list · MCP tool automation_list · scopes automation:read

Input

None: send {}.

Output `object[]`

`actions`	`object[]`
`conditions`	`object[]`
`created_at`	`integer`
`created_by`	`string`
`enabled`	`boolean`
`id`	`integer`
`last_run_at`	`integer`
`name`	`string`
`next_run_at`	`integer`	Scheduled rules: when it runs next.
`runs`	`integer`
`trigger`	`object`

curl https://work.nightroll.app/api/v1/automation.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

automation.logread

REST POST /api/v1/automation.log · MCP tool automation_log · scopes automation:read

Input

rule integer One rule's runs; omit for all.

Output `object[]`

`actor`	`string`
`at`	`integer`
`event`	`string`
`id`	`integer`
`label`	`string`	The subject's key or title at the time.
`message`	`string`
`ok`	`boolean`
`rule`	`integer`
`subject`	`string`	`kind:id` it ran on; null for scheduled runs.

curl https://work.nightroll.app/api/v1/automation.log \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

automation.runwrite

REST POST /api/v1/automation.run · MCP tool automation_run · scopes admin

Input

idrequired integer

Output `any`

curl https://work.nightroll.app/api/v1/automation.run \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

automation.savewrite

REST POST /api/v1/automation.save · MCP tool automation_save · scopes admin

Input

`actions`	`object[]`
`conditions`	`object[]`
`enabled`	`boolean`
`id`	`integer`	Omit to create.
`name`	`string`
`trigger`	`object`

Output `object`

`actions`	`object[]`
`conditions`	`object[]`
`created_at`	`integer`
`created_by`	`string`
`enabled`	`boolean`
`id`	`integer`
`last_run_at`	`integer`
`name`	`string`
`next_run_at`	`integer`	Scheduled rules: when it runs next.
`runs`	`integer`
`trigger`	`object`

curl https://work.nightroll.app/api/v1/automation.save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

chat

chat.bot_tokenwrite

REST POST /api/v1/chat.bot_token · MCP tool chat_bot_token · scopes system

Input

idrequired integer

Output `object`

token string

curl https://work.nightroll.app/api/v1/chat.bot_token \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

chat.connection_deletedestructive

REST POST /api/v1/chat.connection_delete · MCP tool chat_connection_delete · scopes admin

Input

idrequired integer

Output `object`

`created_at`	`integer`
`created_by`	`string`
`has_bot_token`	`boolean`	Slack only: a bot token is stored (needed for unfurls).
`hook_path`	`string`	Request URL to give the platform (after the site's address).
`id`	`integer`
`last_error`	`string`
`last_event_at`	`integer`
`linked`	`integer`	Chat accounts linked to members.
`name`	`string`
`project`	`string`	Default project for `create` without one and for issues made from messages.
`provider`	`string`	slack \| teams \| discord
`requests`	`integer`

curl https://work.nightroll.app/api/v1/chat.connection_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

chat.connection_savewrite

REST POST /api/v1/chat.connection_save · MCP tool chat_connection_save · scopes admin

Input

`bot_token`	`string`	Slack bot token (xoxb-…), for unfurls; "" removes it. Kept when omitted.
`id`	`integer`
`name`	`string`
`project`	`string`
`provider`	`string`	slack \| teams \| discord (new connections).
`secret`	`string`	Slack signing secret, Teams outgoing-webhook security token, or Discord application public key. Kept when omitted.

Output `object`

`created_at`	`integer`
`created_by`	`string`
`has_bot_token`	`boolean`	Slack only: a bot token is stored (needed for unfurls).
`hook_path`	`string`	Request URL to give the platform (after the site's address).
`id`	`integer`
`last_error`	`string`
`last_event_at`	`integer`
`linked`	`integer`	Chat accounts linked to members.
`name`	`string`
`project`	`string`	Default project for `create` without one and for issues made from messages.
`provider`	`string`	slack \| teams \| discord
`requests`	`integer`

curl https://work.nightroll.app/api/v1/chat.connection_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

chat.connectionsread

REST POST /api/v1/chat.connections · MCP tool chat_connections · scopes chat:read

Input

None: send {}.

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`has_bot_token`	`boolean`	Slack only: a bot token is stored (needed for unfurls).
`hook_path`	`string`	Request URL to give the platform (after the site's address).
`id`	`integer`
`last_error`	`string`
`last_event_at`	`integer`
`linked`	`integer`	Chat accounts linked to members.
`name`	`string`
`project`	`string`	Default project for `create` without one and for issues made from messages.
`provider`	`string`	slack \| teams \| discord
`requests`	`integer`

curl https://work.nightroll.app/api/v1/chat.connections \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

chat.ingestwrite

REST POST /api/v1/chat.ingest · MCP tool chat_ingest · scopes system

Input

`body`required	`string`	The raw body (the signature covers it).
`connection`required	`integer`
`headers`required	`object`	Request headers, lowercase names.
`members`	`object`	Org members `{id: {scopes, teams}}`, so linked chat users act as themselves.
`origin`	`string`	The site's address as the platform called it (for links in replies).

Output `object`

`reply`	`any`	The JSON to answer the platform with (null = empty 200).
`result`	`string`	accepted \| refused (bad signature)

curl https://work.nightroll.app/api/v1/chat.ingest \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","connection":1,"headers":"<headers>"}'

chat.linkwrite

REST POST /api/v1/chat.link · MCP tool chat_link · scopes chat:write

Input

coderequired string

Output `object`

`chat_user`	`string`
`connection`	`integer`
`connection_name`	`string`
`linked_at`	`integer`
`name`	`string`
`provider`	`string`

curl https://work.nightroll.app/api/v1/chat.link \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"code":"<code>"}'

chat.linksread

REST POST /api/v1/chat.links · MCP tool chat_links · scopes chat:read

Input

None: send {}.

Output `object[]`

`chat_user`	`string`
`connection`	`integer`
`connection_name`	`string`
`linked_at`	`integer`
`name`	`string`
`provider`	`string`

curl https://work.nightroll.app/api/v1/chat.links \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

chat.subscription_deletedestructive

REST POST /api/v1/chat.subscription_delete · MCP tool chat_subscription_delete · scopes admin

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/chat.subscription_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

chat.subscription_savewrite

REST POST /api/v1/chat.subscription_save · MCP tool chat_subscription_save · scopes admin

Input

`connection`	`integer`
`events`	`string[]`	Any of issue.created, issue.updated, issue.assigned, issue.deleted, comment.created.
`id`	`integer`
`name`	`string`
`origin`	`string`	The site's address, for links in posts (the web sends its own).
`tql`	`string`	Issues to post about, e.g. `project = WEB AND priority = high`; empty = every issue.
`webhook_url`	`string`	The channel's incoming webhook URL. Kept when omitted.

Output `object`

`connection`	`integer`
`created_at`	`integer`
`created_by`	`string`
`events`	`string[]`
`id`	`integer`
`last_sent_at`	`integer`
`name`	`string`
`sent`	`integer`
`tql`	`string`

curl https://work.nightroll.app/api/v1/chat.subscription_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

chat.subscription_testwrite

REST POST /api/v1/chat.subscription_test · MCP tool chat_subscription_test · scopes admin

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/chat.subscription_test \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

chat.subscriptionsread

REST POST /api/v1/chat.subscriptions · MCP tool chat_subscriptions · scopes chat:read

Input

None: send {}.

Output `object[]`

`connection`	`integer`
`created_at`	`integer`
`created_by`	`string`
`events`	`string[]`
`id`	`integer`
`last_sent_at`	`integer`
`name`	`string`
`sent`	`integer`
`tql`	`string`

curl https://work.nightroll.app/api/v1/chat.subscriptions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

chat.unlinkwrite

REST POST /api/v1/chat.unlink · MCP tool chat_unlink · scopes chat:write

Input

`chat_user`required	`string`
`connection`required	`integer`

Output `object`

id integer

curl https://work.nightroll.app/api/v1/chat.unlink \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"chat_user":"<chat_user>","connection":1}'

checklists

checklists.addwrite

REST POST /api/v1/checklists.add · MCP tool checklists_add · scopes issues:write

Input

`assignee`	`string`
`due_date`	`string`
`key`required	`string`
`text`required	`string`	One item, or several separated by new lines.

Output `object`

`can_edit`	`boolean`	The caller can change it (edits the issue).
`done`	`integer`
`items`	`object[]`
`key`	`string`
`total`	`integer`

curl https://work.nightroll.app/api/v1/checklists.add \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","text":"<text>"}'

checklists.applywrite

REST POST /api/v1/checklists.apply · MCP tool checklists_apply · scopes issues:write

Input

`key`required	`string`
`template`required	`integer`

Output `object`

`can_edit`	`boolean`	The caller can change it (edits the issue).
`done`	`integer`
`items`	`object[]`
`key`	`string`
`total`	`integer`

curl https://work.nightroll.app/api/v1/checklists.apply \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","template":1}'

checklists.deletedestructive

REST POST /api/v1/checklists.delete · MCP tool checklists_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/checklists.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

checklists.listread

REST POST /api/v1/checklists.list · MCP tool checklists_list · scopes issues:read

Input

keyrequired string

Output `object`

`can_edit`	`boolean`	The caller can change it (edits the issue).
`done`	`integer`
`items`	`object[]`
`key`	`string`
`total`	`integer`

curl https://work.nightroll.app/api/v1/checklists.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

checklists.reorderwrite

REST POST /api/v1/checklists.reorder · MCP tool checklists_reorder · scopes issues:write

Input

`ids`required	`integer[]`	Item ids in their new order.
`key`required	`string`

Output `object`

`can_edit`	`boolean`	The caller can change it (edits the issue).
`done`	`integer`
`items`	`object[]`
`key`	`string`
`total`	`integer`

curl https://work.nightroll.app/api/v1/checklists.reorder \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"ids":1,"key":"<key>"}'

checklists.template_deletedestructive

REST POST /api/v1/checklists.template_delete · MCP tool checklists_template_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/checklists.template_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

checklists.template_savewrite

REST POST /api/v1/checklists.template_save · MCP tool checklists_template_save · scopes admin

Input

`auto`	`boolean`
`id`	`integer`
`items`required	`string[]`
`kind`required	`string`
`name`required	`string`

Output `object[]`

`auto`	`boolean`	Added to every new issue of the type.
`id`	`integer`
`items`	`string[]`
`kind`	`string`	Issue type key.
`name`	`string`

curl https://work.nightroll.app/api/v1/checklists.template_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"items":[],"kind":"<kind>","name":"<name>"}'

checklists.templatesread

REST POST /api/v1/checklists.templates · MCP tool checklists_templates · scopes issues:read

Input

None: send {}.

Output `object[]`

`auto`	`boolean`	Added to every new issue of the type.
`id`	`integer`
`items`	`string[]`
`kind`	`string`	Issue type key.
`name`	`string`

curl https://work.nightroll.app/api/v1/checklists.templates \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

checklists.updatewrite

REST POST /api/v1/checklists.update · MCP tool checklists_update · scopes issues:write

Input

`assignee`	`string`	"" unassigns.
`done`	`boolean`
`due_date`	`string`	"" clears.
`id`required	`integer`
`text`	`string`

Output `object`

`can_edit`	`boolean`	The caller can change it (edits the issue).
`done`	`integer`
`items`	`object[]`
`key`	`string`
`total`	`integer`

curl https://work.nightroll.app/api/v1/checklists.update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

comments

comments.createwrite

REST POST /api/v1/comments.create · MCP tool comments_create · scopes comments:write

Input

`anchor`	`string`	Inline comment: JSON `{"exact": "quoted text", "prefix": "…", "suffix": "…"}` locating the text it's about.
`body`required	`string`	Markdown (what search, mentions, email and agents read).
`body_doc`	`string`	The same body as a rich document (TipTap JSON, as the web editor writes it); optional.
`internal`	`boolean`	An internal note: the team sees it, customers in the service desk portal never do. Replies follow their thread.
`parent`	`integer`	Reply to this comment's thread.
`subject`required	`string`

Output `object`

id integer

curl https://work.nightroll.app/api/v1/comments.create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","subject":"<subject>"}'

comments.deletedestructive

REST POST /api/v1/comments.delete · MCP tool comments_delete · scopes comments:write

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/comments.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

comments.importwrite

REST POST /api/v1/comments.import · MCP tool comments_import · scopes admin

Input

`author`required	`string`	Member id, or a name for someone who isn't a member.
`body`required	`string`	Markdown.
`created_at`	`integer`	Unix seconds.
`subject`required	`string`

Output `object`

id integer

curl https://work.nightroll.app/api/v1/comments.import \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"author":"<author>","body":"<body>","subject":"<subject>"}'

comments.listread

REST POST /api/v1/comments.list · MCP tool comments_list · scopes comments:read

Input

subjectrequired string

Output `object[]`

`anchor`	`string`	Inline anchor JSON (thread starters only).
`author`	`string`
`body`	`string`
`body_doc`	`string`	The body as a rich document (TipTap JSON); null when there's only markdown.
`created_at`	`integer`
`edited_at`	`integer`	When the author last edited it.
`id`	`integer`
`internal`	`boolean`	An internal note (not shown to customers).
`parent`	`integer`	The thread's first comment; null for a thread starter.
`reactions`	`object[]`
`resolved_at`	`integer`
`resolved_by`	`string`

curl https://work.nightroll.app/api/v1/comments.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>"}'

comments.reactwrite

REST POST /api/v1/comments.react · MCP tool comments_react · scopes comments:write

Input

`emoji`required	`string`	One emoji (or a short code), 16 bytes max.
`id`required	`integer`
`on`required	`boolean`	false removes it.

Output `object`

id integer

curl https://work.nightroll.app/api/v1/comments.react \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"emoji":"<emoji>","id":1,"on":true}'

comments.resolvewrite

REST POST /api/v1/comments.resolve · MCP tool comments_resolve · scopes comments:write

Input

`id`required	`integer`	The thread's first comment.
`resolved`required	`boolean`	false reopens it.

Output `object`

id integer

curl https://work.nightroll.app/api/v1/comments.resolve \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"resolved":true}'

comments.updatewrite

REST POST /api/v1/comments.update · MCP tool comments_update · scopes comments:write

Input

`body`required	`string`	Markdown. Without `body_doc` it replaces the rich document too.
`body_doc`	`string`
`id`required	`integer`

Output `object`

id integer

curl https://work.nightroll.app/api/v1/comments.update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","id":1}'

desk

desk.chat_requestwrite

REST POST /api/v1/desk.chat_request · MCP tool desk_chat_request · scopes system

Input

`channel`	`string`	Where replies go (Slack: the channel id).
`chat_name`	`string`
`chat_user`required	`string`
`connection`required	`integer`
`project`required	`string`	The desk's project (the chat connection's default project).
`provider`required	`string`	slack \| teams \| discord
`text`required	`string`	First line the summary, the rest the description.

Output `object`

`key`	`string`
`reply`	`string`	What to tell the sender.
`result`	`string`	created \| commented \| ignored

curl https://work.nightroll.app/api/v1/desk.chat_request \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"chat_user":"<chat_user>","connection":1,"project":"<project>","provider":"<provider>","text":"<text>"}'

desk.chat_statuswrite

REST POST /api/v1/desk.chat_status · MCP tool desk_chat_status · scopes system

Input

`chat_user`required	`string`
`connection`required	`integer`
`key`required	`string`

Output `object`

`key`	`string`
`reply`	`string`	What to tell the sender.
`result`	`string`	created \| commented \| ignored

curl https://work.nightroll.app/api/v1/desk.chat_status \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"chat_user":"<chat_user>","connection":1,"key":"<key>"}'

desk.customer_addwrite

REST POST /api/v1/desk.customer_add · MCP tool desk_customer_add · scopes issues:write

Input

`email`required	`string`
`name`required	`string`

Output `object`

`customer`	`object`
`password`	`string`	A password to hand to the customer (shown once); they sign in to the portal with it.

curl https://work.nightroll.app/api/v1/desk.customer_add \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"email":"<email>","name":"<name>"}'

desk.customer_blockwrite

REST POST /api/v1/desk.customer_block · MCP tool desk_customer_block · scopes admin

Input

`blocked`required	`boolean`
`id`required	`integer`

Output `object`

`active`	`boolean`	They've set a password (signed up, or were given one).
`blocked`	`boolean`
`created_at`	`integer`
`email`	`string`
`id`	`integer`
`last_seen_at`	`integer`
`name`	`string`
`requests`	`integer`

curl https://work.nightroll.app/api/v1/desk.customer_block \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"blocked":true,"id":1}'

desk.customer_resetwrite

REST POST /api/v1/desk.customer_reset · MCP tool desk_customer_reset · scopes issues:write

Input

idrequired integer

Output `object`

`customer`	`object`
`password`	`string`	A password to hand to the customer (shown once); they sign in to the portal with it.

curl https://work.nightroll.app/api/v1/desk.customer_reset \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

desk.customersread

REST POST /api/v1/desk.customers · MCP tool desk_customers · scopes issues:read

Input

q string

Output `object[]`

`active`	`boolean`	They've set a password (signed up, or were given one).
`blocked`	`boolean`
`created_at`	`integer`
`email`	`string`
`id`	`integer`
`last_seen_at`	`integer`
`name`	`string`
`requests`	`integer`

curl https://work.nightroll.app/api/v1/desk.customers \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

desk.deflection_statsread

REST POST /api/v1/desk.deflection_stats · MCP tool desk_deflection_stats · scopes issues:read

Input

projectrequired string

Output `object`

`requests`	`integer`
`solved`	`integer`
`top`	`any[][]`	Articles that solved the most, with counts.
`viewed`	`integer`	The last 30 days.

curl https://work.nightroll.app/api/v1/desk.deflection_stats \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

desk.email_addresswrite

REST POST /api/v1/desk.email_address · MCP tool desk_email_address · scopes admin

Input

projectrequired string

Output `object`

path string POST inbound email here (Postmark, Mailgun, SendGrid inbound parse, or JSON `{from, name, subject, text}`).

curl https://work.nightroll.app/api/v1/desk.email_address \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

desk.email_ingestwrite

REST POST /api/v1/desk.email_ingest · MCP tool desk_email_ingest · scopes system

Input

`from`required	`string`	The sender's address and name.
`name`	`string`
`subject`	`string`
`text`	`string`
`token`required	`string`	The token in the desk's email webhook address.

Output `object`

`key`	`string`
`reply`	`string`	What to tell the sender.
`result`	`string`	created \| commented \| ignored

curl https://work.nightroll.app/api/v1/desk.email_ingest \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"from":"<from>","token":"<token>"}'

desk.listread

REST POST /api/v1/desk.list · MCP tool desk_list · scopes issues:read

Input

None: send {}.

Output `object[]`

`enabled`	`boolean`
`intro`	`string`
`kb_space`	`string`	The pages space whose articles the portal suggests (W704).
`name`	`string`
`open_signup`	`boolean`	Anyone may create a portal account (else agents add customers).
`project`	`string`

curl https://work.nightroll.app/api/v1/desk.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

desk.portal_articlewrite

REST POST /api/v1/desk.portal_article · MCP tool desk_portal_article · scopes desk:public

Input

idrequired string

Output `object`

`id`	`string`
`text`	`string`	Markdown.
`title`	`string`

curl https://work.nightroll.app/api/v1/desk.portal_article \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

desk.portal_commentwrite

REST POST /api/v1/desk.portal_comment · MCP tool desk_portal_comment · scopes desk:portal

Input

`body`required	`string`
`key`required	`string`

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/desk.portal_comment \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","key":"<key>"}'

desk.portal_createwrite

REST POST /api/v1/desk.portal_create · MCP tool desk_portal_create · scopes desk:portal

Input

`title`required	`string`
`type`required	`integer`
`values`	`object`

Output `object`

`category`	`string`
`created_at`	`integer`
`desk`	`string`
`key`	`string`
`request_type`	`string`
`status`	`string`	The lane's name, and its category (todo \| in_progress \| done).
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/desk.portal_create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"title":"<title>","type":1}'

desk.portal_formwrite

REST POST /api/v1/desk.portal_form · MCP tool desk_portal_form · scopes desk:portal

Input

`type`required	`integer`
`values`	`object`

Output `any`

curl https://work.nightroll.app/api/v1/desk.portal_form \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"type":1}'

desk.portal_infowrite

REST POST /api/v1/desk.portal_info · MCP tool desk_portal_info · scopes desk:public

Input

None: send {}.

Output `object[]`

`has_articles`	`boolean`	Help articles to suggest (W704).
`intro`	`string`
`name`	`string`
`open_signup`	`boolean`
`project`	`string`
`types`	`object[]`

curl https://work.nightroll.app/api/v1/desk.portal_info \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

desk.portal_loginwrite

REST POST /api/v1/desk.portal_login · MCP tool desk_portal_login · scopes desk:public

Input

`email`required	`string`
`password`required	`string`

Output `object`

`customer`	`object`
`token`	`string`	`Authorization: Bearer kbc_…` for the portal ops.

curl https://work.nightroll.app/api/v1/desk.portal_login \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"email":"<email>","password":"<password>"}'

desk.portal_logoutwrite

REST POST /api/v1/desk.portal_logout · MCP tool desk_portal_logout · scopes desk:portal

Input

None: send {}.

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/desk.portal_logout \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

desk.portal_mewrite

REST POST /api/v1/desk.portal_me · MCP tool desk_portal_me · scopes desk:portal

Input

None: send {}.

Output `object`

`active`	`boolean`	They've set a password (signed up, or were given one).
`blocked`	`boolean`
`created_at`	`integer`
`email`	`string`
`id`	`integer`
`last_seen_at`	`integer`
`name`	`string`
`requests`	`integer`

curl https://work.nightroll.app/api/v1/desk.portal_me \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

desk.portal_requestwrite

REST POST /api/v1/desk.portal_request · MCP tool desk_portal_request · scopes desk:portal

Input

keyrequired string

Output `object`

`comments`	`object[]`
`description`	`string`
`request`	`object`

curl https://work.nightroll.app/api/v1/desk.portal_request \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

desk.portal_requestswrite

REST POST /api/v1/desk.portal_requests · MCP tool desk_portal_requests · scopes desk:portal

Input

None: send {}.

Output `object[]`

`category`	`string`
`created_at`	`integer`
`desk`	`string`
`key`	`string`
`request_type`	`string`
`status`	`string`	The lane's name, and its category (todo \| in_progress \| done).
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/desk.portal_requests \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

desk.portal_signupwrite

REST POST /api/v1/desk.portal_signup · MCP tool desk_portal_signup · scopes desk:public

Input

`email`required	`string`
`name`required	`string`
`password`required	`string`

Output `object`

`customer`	`object`
`token`	`string`	`Authorization: Bearer kbc_…` for the portal ops.

curl https://work.nightroll.app/api/v1/desk.portal_signup \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"email":"<email>","name":"<name>","password":"<password>"}'

desk.portal_solvedwrite

REST POST /api/v1/desk.portal_solved · MCP tool desk_portal_solved · scopes desk:public

Input

`page`required	`string`	The article that answered it.
`query`	`string`
`type`	`integer`

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/desk.portal_solved \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"page":"<page>"}'

desk.portal_suggestwrite

REST POST /api/v1/desk.portal_suggest · MCP tool desk_portal_suggest · scopes desk:public

Input

`text`required	`string`	What the customer typed so far.
`type`	`integer`	The request type being filled (its desk's knowledge base); none = every desk's.

Output `object[]`

`id`	`string`
`snippet`	`string`
`title`	`string`

curl https://work.nightroll.app/api/v1/desk.portal_suggest \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"text":"<text>"}'

desk.queueread

REST POST /api/v1/desk.queue · MCP tool desk_queue · scopes issues:read

Input

`id`required	`integer`
`limit`	`integer`

Output `object`

`queue`	`object`
`rows`	`object[]`
`total`	`integer`

curl https://work.nightroll.app/api/v1/desk.queue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

desk.queue_deletedestructive

REST POST /api/v1/desk.queue_delete · MCP tool desk_queue_delete · scopes admin

Input

idrequired integer

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/desk.queue_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

desk.queue_savewrite

REST POST /api/v1/desk.queue_save · MCP tool desk_queue_save · scopes admin

Input

`id`	`integer`
`name`required	`string`
`project`required	`string`
`tql`required	`string`	TQL; `project = <key>` is added.

Output `object[]`

`id`	`integer`
`name`	`string`
`project`	`string`
`tql`	`string`

curl https://work.nightroll.app/api/v1/desk.queue_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","project":"<project>","tql":"<tql>"}'

desk.requestread

REST POST /api/v1/desk.request · MCP tool desk_request · scopes issues:read

Input

keyrequired string

Output `object`

`channel`	`string`	portal \| agent
`created_at`	`integer`
`customer`	`object`
`issue`	`integer`
`key`	`string`
`participants`	`integer[]`
`project`	`string`
`type`	`integer`	Request type id and name.
`type_name`	`string`

curl https://work.nightroll.app/api/v1/desk.request \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

desk.request_createwrite

REST POST /api/v1/desk.request_create · MCP tool desk_request_create · scopes issues:write

Input

`customer`required	`integer`
`title`required	`string`
`type`required	`integer`
`values`	`object`

Output `any`

curl https://work.nightroll.app/api/v1/desk.request_create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"customer":1,"title":"<title>","type":1}'

desk.savewrite

REST POST /api/v1/desk.save · MCP tool desk_save · scopes admin

Input

`enabled`required	`boolean`
`intro`	`string`
`kb_space`	`string`	A pages space to suggest articles from (empty = none).
`name`	`string`	The portal's name for this desk (default: the project's).
`open_signup`	`boolean`
`project`required	`string`

Output `object`

`desk`	`object`
`queues`	`object[]`
`types`	`object[]`

curl https://work.nightroll.app/api/v1/desk.save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"enabled":true,"project":"<project>"}'

desk.settingsread

REST POST /api/v1/desk.settings · MCP tool desk_settings · scopes issues:read

Input

projectrequired string

Output `object`

`desk`	`object`
`queues`	`object[]`
`types`	`object[]`

curl https://work.nightroll.app/api/v1/desk.settings \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

desk.type_deletedestructive

REST POST /api/v1/desk.type_delete · MCP tool desk_type_delete · scopes admin

Input

idrequired integer

Output `object[]`

`description`	`string`
`enabled`	`boolean`
`fields`	`object[]`
`id`	`integer`
`kind`	`string`	The issue type key requests of this type get.
`name`	`string`
`position`	`number`
`project`	`string`

curl https://work.nightroll.app/api/v1/desk.type_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

desk.type_savewrite

REST POST /api/v1/desk.type_save · MCP tool desk_type_save · scopes admin

Input

`description`	`string`
`enabled`	`boolean`
`fields`	`object[]`
`id`	`integer`
`kind`required	`string`	Issue type key.
`name`required	`string`
`position`	`number`
`project`required	`string`

Output `object[]`

`description`	`string`
`enabled`	`boolean`
`fields`	`object[]`
`id`	`integer`
`kind`	`string`	The issue type key requests of this type get.
`name`	`string`
`position`	`number`
`project`	`string`

curl https://work.nightroll.app/api/v1/desk.type_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"kind":"<kind>","name":"<name>","project":"<project>"}'

diagrams

diagrams.renderread

REST POST /api/v1/diagrams.render · MCP tool diagrams_render · scopes diagrams:read

Input

`code`required	`string`
`kind`required	`string`	plantuml

Output `object`

`error`	`string`
`id`	`integer`
`server`	`string`	The server that rendered it.
`state`	`string`	pending (being rendered) \| ok \| error
`svg`	`string`	The SVG (PlantUML draws syntax errors into it too); show it as an image, never inline.

curl https://work.nightroll.app/api/v1/diagrams.render \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"code":"<code>","kind":"<kind>"}'

diagrams.render_resultwrite

REST POST /api/v1/diagrams.render_result · MCP tool diagrams_render_result · scopes system

Input

`error`	`string`
`id`required	`integer`
`ok`required	`boolean`
`svg`	`string`

Output `object`

`error`	`string`
`id`	`integer`
`server`	`string`	The server that rendered it.
`state`	`string`	pending (being rendered) \| ok \| error
`svg`	`string`	The SVG (PlantUML draws syntax errors into it too); show it as an image, never inline.

curl https://work.nightroll.app/api/v1/diagrams.render_result \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"ok":true}'

diagrams.settingsread

REST POST /api/v1/diagrams.settings · MCP tool diagrams_settings · scopes diagrams:read

Input

None: send {}.

Output `object`

`plantuml_enabled`	`boolean`	PlantUML diagrams render (their source is sent to `plantuml_server`).
`plantuml_server`	`string`	Base URL of the PlantUML server (`…/plantuml`, the part before `/svg`).

curl https://work.nightroll.app/api/v1/diagrams.settings \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

diagrams.settings_setwrite

REST POST /api/v1/diagrams.settings_set · MCP tool diagrams_settings_set · scopes admin

Input

`plantuml_enabled`	`boolean`
`plantuml_server`	`string`

Output `object`

`plantuml_enabled`	`boolean`	PlantUML diagrams render (their source is sent to `plantuml_server`).
`plantuml_server`	`string`	Base URL of the PlantUML server (`…/plantuml`, the part before `/svg`).

curl https://work.nightroll.app/api/v1/diagrams.settings_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

errors

errors.ingestwrite

REST POST /api/v1/errors.ingest · MCP tool errors_ingest · scopes system

Input

`body`required	`string`
`headers`required	`object`	Request headers, lowercase names (plus `token` from the query string).
`source`required	`integer`

Output `object`

`issue`	`string`
`result`	`string`	created \| updated \| reopened \| resolved \| ignored \| refused

curl https://work.nightroll.app/api/v1/errors.ingest \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","headers":"<headers>","source":1}'

errors.issueread

REST POST /api/v1/errors.issue · MCP tool errors_issue · scopes errors:read

Input

keyrequired string

Output `object[]`

`count`	`integer`
`culprit`	`string`
`environment`	`string`
`first_seen`	`integer`
`last_seen`	`integer`
`level`	`string`
`provider`	`string`
`resolved`	`boolean`
`source`	`string`
`title`	`string`
`url`	`string`

curl https://work.nightroll.app/api/v1/errors.issue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

errors.source_deletedestructive

REST POST /api/v1/errors.source_delete · MCP tool errors_source_delete · scopes admin

Input

idrequired integer

Output `object`

`created_at`	`integer`
`created_by`	`string`
`deliveries`	`integer`
`groups`	`integer`	Error groups seen.
`hook_path`	`string`	Webhook path (after the site's address).
`id`	`integer`
`kind`	`string`	Issue type for new issues ("" = the project's default).
`labels`	`string[]`	Labels for new issues (existing labels).
`last_error`	`string`
`last_event_at`	`integer`
`name`	`string`
`priority`	`string`	Priority for new issues ("" = the default).
`project`	`string`	Project the issues go to.
`provider`	`string`	sentry \| datadog \| rollbar
`reopen`	`boolean`	Reopen a done issue when its error happens again.

curl https://work.nightroll.app/api/v1/errors.source_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

errors.source_savewrite

REST POST /api/v1/errors.source_save · MCP tool errors_source_save · scopes admin

Input

`id`	`integer`
`kind`	`string`
`labels`	`string[]`
`name`	`string`
`priority`	`string`
`project`	`string`
`provider`	`string`	sentry \| datadog \| rollbar (new sources).
`reopen`	`boolean`
`secret`	`string`	Sentry: the integration's client secret. Datadog and Rollbar get a generated token when omitted.

Output `object`

`secret`	`string`	The secret/token, when it was generated now (paste it into Datadog's header or Rollbar's URL).
`source`	`object`

curl https://work.nightroll.app/api/v1/errors.source_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

errors.source_secretwrite

REST POST /api/v1/errors.source_secret · MCP tool errors_source_secret · scopes admin

Input

idrequired integer

Output `object`

secret string

curl https://work.nightroll.app/api/v1/errors.source_secret \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

errors.sourcesread

REST POST /api/v1/errors.sources · MCP tool errors_sources · scopes errors:read

Input

None: send {}.

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`deliveries`	`integer`
`groups`	`integer`	Error groups seen.
`hook_path`	`string`	Webhook path (after the site's address).
`id`	`integer`
`kind`	`string`	Issue type for new issues ("" = the project's default).
`labels`	`string[]`	Labels for new issues (existing labels).
`last_error`	`string`
`last_event_at`	`integer`
`name`	`string`
`priority`	`string`	Priority for new issues ("" = the default).
`project`	`string`	Project the issues go to.
`provider`	`string`	sentry \| datadog \| rollbar
`reopen`	`boolean`	Reopen a done issue when its error happens again.

curl https://work.nightroll.app/api/v1/errors.sources \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

export

export.buildwriteWhat the cell passes in: members and teams live in the directory, outside the org file.

REST POST /api/v1/export.build · MCP tool export_build · scopes system

Input

`directory`required	`any`
`id`required	`integer`

Output `any`

curl https://work.nightroll.app/api/v1/export.build \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"directory":"<directory>","id":1}'

export.downloadwrite

REST POST /api/v1/export.download · MCP tool export_download · scopes owner

Input

`as_url`	`boolean`	A download link instead of the bytes, where the deployment serves files from their own origin.
`id`required	`integer`

Output `object`

`data`	`string`	Base64 of the `.tar` (empty when `url` is given).
`name`	`string`
`url`	`string`	With `as_url`, where the deployment has a files origin: a five-minute link that downloads it.

curl https://work.nightroll.app/api/v1/export.download \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

export.listwrite

REST POST /api/v1/export.list · MCP tool export_list · scopes owner

Input

None: send {}.

Output `object[]`

`counts`	`any`	What's inside: rows per table, issues, pages, files.
`created_at`	`integer`
`error`	`string`
`finished_at`	`integer`
`id`	`integer`
`requested_by`	`string`
`size`	`integer`	Bytes of the archive.
`state`	`string`	queued \| ready \| failed

curl https://work.nightroll.app/api/v1/export.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

export.startwrite

REST POST /api/v1/export.start · MCP tool export_start · scopes owner

Input

None: send {}.

Output `object`

`counts`	`any`	What's inside: rows per table, issues, pages, files.
`created_at`	`integer`
`error`	`string`
`finished_at`	`integer`
`id`	`integer`
`requested_by`	`string`
`size`	`integer`	Bytes of the archive.
`state`	`string`	queued \| ready \| failed

curl https://work.nightroll.app/api/v1/export.start \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

feedback

feedback.board_savewrite

REST POST /api/v1/feedback.board_save · MCP tool feedback_board_save · scopes admin

Input

`description`	`string`
`enabled`	`boolean`
`id`	`integer`
`name`required	`string`
`visibility`	`string`	public \| signed_in \| team

Output `object[]`

`description`	`string`
`enabled`	`boolean`
`id`	`integer`
`name`	`string`
`position`	`number`
`visibility`	`string`	public (anyone, signed out too) \| signed_in (portal accounts) \| team (members only)

curl https://work.nightroll.app/api/v1/feedback.board_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>"}'

feedback.boardsread

REST POST /api/v1/feedback.boards · MCP tool feedback_boards · scopes feedback:read

Input

None: send {}.

Output `object[]`

`description`	`string`
`enabled`	`boolean`
`id`	`integer`
`name`	`string`
`position`	`number`
`visibility`	`string`	public (anyone, signed out too) \| signed_in (portal accounts) \| team (members only)

curl https://work.nightroll.app/api/v1/feedback.boards \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

feedback.createwrite

REST POST /api/v1/feedback.create · MCP tool feedback_create · scopes feedback:write

Input

`board`required	`integer`
`body`	`string`
`title`required	`string`

Output `object`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"board":1,"title":"<title>"}'

feedback.idearead

REST POST /api/v1/feedback.idea · MCP tool feedback_idea · scopes feedback:read

Input

idrequired integer

Output `object`

`comments`	`any[][]`	Public comments (portal) or all (team): (id, author name, mine, body, internal, created_at).
`idea`	`object`
`voters`	`string[]`	Voters (team views only): member ids and customer names.

curl https://work.nightroll.app/api/v1/feedback.idea \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

feedback.ideasread

REST POST /api/v1/feedback.ideas · MCP tool feedback_ideas · scopes feedback:read

Input

`board`	`integer`
`q`	`string`
`sort`	`string`	votes (default) \| new \| updated
`status`	`string`

Output `object[]`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.ideas \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

feedback.linkwrite

REST POST /api/v1/feedback.link · MCP tool feedback_link · scopes feedback:write

Input

`id`required	`integer`
`issue`required	`string`
`linked`	`boolean`

Output `object`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.link \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"issue":"<issue>"}'

feedback.mergewrite

REST POST /api/v1/feedback.merge · MCP tool feedback_merge · scopes feedback:write

Input

`id`required	`integer`	The duplicate.
`into`required	`integer`	The idea it goes into (votes move there).

Output `object`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.merge \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"into":1}'

feedback.portal_boardswrite

REST POST /api/v1/feedback.portal_boards · MCP tool feedback_portal_boards · scopes desk:public

Input

None: send {}.

Output `object[]`

`description`	`string`
`enabled`	`boolean`
`id`	`integer`
`name`	`string`
`position`	`number`
`visibility`	`string`	public (anyone, signed out too) \| signed_in (portal accounts) \| team (members only)

curl https://work.nightroll.app/api/v1/feedback.portal_boards \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

feedback.portal_commentwrite

REST POST /api/v1/feedback.portal_comment · MCP tool feedback_portal_comment · scopes desk:portal

Input

`body`required	`string`
`id`required	`integer`

Output `object`

`comments`	`any[][]`	Public comments (portal) or all (team): (id, author name, mine, body, internal, created_at).
`idea`	`object`
`voters`	`string[]`	Voters (team views only): member ids and customer names.

curl https://work.nightroll.app/api/v1/feedback.portal_comment \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","id":1}'

feedback.portal_ideawrite

REST POST /api/v1/feedback.portal_idea · MCP tool feedback_portal_idea · scopes desk:public

Input

idrequired integer

Output `object`

`comments`	`any[][]`	Public comments (portal) or all (team): (id, author name, mine, body, internal, created_at).
`idea`	`object`
`voters`	`string[]`	Voters (team views only): member ids and customer names.

curl https://work.nightroll.app/api/v1/feedback.portal_idea \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

feedback.portal_ideaswrite

REST POST /api/v1/feedback.portal_ideas · MCP tool feedback_portal_ideas · scopes desk:public

Input

`board`	`integer`
`q`	`string`
`sort`	`string`	votes (default) \| new \| updated
`status`	`string`

Output `object[]`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.portal_ideas \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

feedback.portal_similarwrite

REST POST /api/v1/feedback.portal_similar · MCP tool feedback_portal_similar · scopes desk:public

Input

`board`	`integer`
`text`required	`string`

Output `object[]`

`id`	`integer`
`status`	`string`
`title`	`string`
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.portal_similar \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"text":"<text>"}'

feedback.portal_submitwrite

REST POST /api/v1/feedback.portal_submit · MCP tool feedback_portal_submit · scopes desk:portal

Input

`board`required	`integer`
`body`	`string`
`title`required	`string`

Output `object`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.portal_submit \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"board":1,"title":"<title>"}'

feedback.portal_votewrite

REST POST /api/v1/feedback.portal_vote · MCP tool feedback_portal_vote · scopes desk:portal

Input

`id`required	`integer`
`on`	`boolean`	false takes the vote back.

Output `object`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.portal_vote \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

feedback.updatewrite

REST POST /api/v1/feedback.update · MCP tool feedback_update · scopes feedback:write

Input

`board`	`integer`
`body`	`string`
`id`required	`integer`
`status`	`string`
`title`	`string`

Output `object`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

feedback.votewrite

REST POST /api/v1/feedback.vote · MCP tool feedback_vote · scopes feedback:write

Input

`id`required	`integer`
`on`	`boolean`	false takes the vote back.

Output `object`

`author`	`string`	A member id, or `customer:<id>`.
`author_name`	`string`	The author's name when they're a customer.
`board`	`integer`
`body`	`string`
`created_at`	`integer`
`id`	`integer`
`issues`	`string[]`	Linked issue keys (team views only).
`merged_into`	`integer`	Merged into this idea (its votes moved there).
`shipped_at`	`integer`
`status`	`string`	under_review \| planned \| in_progress \| shipped \| declined
`title`	`string`
`updated_at`	`integer`
`voted`	`boolean`	The caller voted for it.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/feedback.vote \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

flags

flags.listread

REST POST /api/v1/flags.list · MCP tool flags_list · scopes flags:read

Input

None: send {}.

Output `object`

`flags`	`object[]`	Every flag set for the org (unset flags use the code's default).
`modules`	`object[]`	Every module in this cell and whether it's on for the org.

curl https://work.nightroll.app/api/v1/flags.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

flags.setwrite

REST POST /api/v1/flags.set · MCP tool flags_set · scopes admin

Input

`key`required	`string`	`module:<name>` or `feature:<name>`.
`value`required	`any`	JSON value (usually true/false); null clears it back to the default.

Output `object`

`key`	`string`	`module:<name>` or `feature:<name>`.
`updated_at`	`integer`
`updated_by`	`string`
`value`	`any`

curl https://work.nightroll.app/api/v1/flags.set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","value":"<value>"}'

forms

forms.evaluateread

REST POST /api/v1/forms.evaluate · MCP tool forms_evaluate · scopes issues:read

Input

`kind`required	`string`
`project`required	`string`
`values`	`any`	The form's current values, issue-shaped (built-ins by name, custom fields under `fields`).

Output `object`

curl https://work.nightroll.app/api/v1/forms.evaluate \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"kind":"<kind>","project":"<project>"}'

forms.rule_deletedestructive

REST POST /api/v1/forms.rule_delete · MCP tool forms_rule_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/forms.rule_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

forms.rule_reorderwrite

REST POST /api/v1/forms.rule_reorder · MCP tool forms_rule_reorder · scopes admin

Input

idsrequired integer[]

Output `object[]`

`actions`	`object[]`
`conditions`	`object[]`	All must hold (empty = always).
`enabled`	`boolean`
`id`	`integer`
`kinds`	`string[]`	Issue type keys; empty = every type.
`name`	`string`
`position`	`number`
`projects`	`string[]`	Project keys; empty = every project.

curl https://work.nightroll.app/api/v1/forms.rule_reorder \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"ids":1}'

forms.rule_savewrite

REST POST /api/v1/forms.rule_save · MCP tool forms_rule_save · scopes admin

Input

`actions`required	`object[]`
`conditions`	`object[]`
`enabled`	`boolean`
`id`	`integer`
`kinds`	`string[]`
`name`required	`string`
`projects`	`string[]`

Output `object[]`

`actions`	`object[]`
`conditions`	`object[]`	All must hold (empty = always).
`enabled`	`boolean`
`id`	`integer`
`kinds`	`string[]`	Issue type keys; empty = every type.
`name`	`string`
`position`	`number`
`projects`	`string[]`	Project keys; empty = every project.

curl https://work.nightroll.app/api/v1/forms.rule_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"actions":[],"name":"<name>"}'

forms.rulesread

REST POST /api/v1/forms.rules · MCP tool forms_rules · scopes issues:read

Input

None: send {}.

Output `object[]`

`actions`	`object[]`
`conditions`	`object[]`	All must hold (empty = always).
`enabled`	`boolean`
`id`	`integer`
`kinds`	`string[]`	Issue type keys; empty = every type.
`name`	`string`
`position`	`number`
`projects`	`string[]`	Project keys; empty = every project.

curl https://work.nightroll.app/api/v1/forms.rules \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

git

git.branchread

REST POST /api/v1/git.branch · MCP tool git_branch · scopes git:read

Input

keyrequired string

Output `object`

`branch`	`string`
`checkout`	`string`	The command that creates it locally.
`pr_title`	`string`

curl https://work.nightroll.app/api/v1/git.branch \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

git.connection_createwrite

REST POST /api/v1/git.connection_create · MCP tool git_connection_create · scopes admin

Input

`name`required	`string`
`provider`required	`string`

Output `object`

`connection`	`object`
`secret`	`string`	The webhook secret to paste into the provider (also readable later by admins).

curl https://work.nightroll.app/api/v1/git.connection_create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","provider":"<provider>"}'

git.connection_deletedestructive

REST POST /api/v1/git.connection_delete · MCP tool git_connection_delete · scopes admin

Input

idrequired integer

Output `object`

`created_at`	`integer`
`created_by`	`string`
`deliveries`	`integer`
`hook_path`	`string`	Webhook path to give the provider (after the site's address).
`id`	`integer`
`last_error`	`string`	Why the last delivery was refused (bad signature, …), if it was.
`last_event_at`	`integer`
`name`	`string`
`provider`	`string`	github \| gitlab \| bitbucket \| gitea
`repos`	`string[]`

curl https://work.nightroll.app/api/v1/git.connection_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

git.connection_secretwrite

REST POST /api/v1/git.connection_secret · MCP tool git_connection_secret · scopes admin

Input

idrequired integer

Output `object`

secret string

curl https://work.nightroll.app/api/v1/git.connection_secret \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

git.connectionsread

REST POST /api/v1/git.connections · MCP tool git_connections · scopes git:read

Input

None: send {}.

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`deliveries`	`integer`
`hook_path`	`string`	Webhook path to give the provider (after the site's address).
`id`	`integer`
`last_error`	`string`	Why the last delivery was refused (bad signature, …), if it was.
`last_event_at`	`integer`
`name`	`string`
`provider`	`string`	github \| gitlab \| bitbucket \| gitea
`repos`	`string[]`

curl https://work.nightroll.app/api/v1/git.connections \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

git.doraread

REST POST /api/v1/git.dora · MCP tool git_dora · scopes git:read

Input

`days`	`integer`	Window in days (default 30).
`project`	`string`	Only deployments linked to this project's issues.

Output `object`

`change_failure_rate`	`number`	Failed share of finished production deployments, 0–1.
`days`	`integer`
`deployments`	`integer`	Successful production deployments in the window.
`deployments_per_day`	`number`
`environments`	`string[]`
`lead_time_hours`	`number`	Median hours from an issue's first commit to its first successful production deployment.
`restore_hours`	`number`	Median hours from a failed production deployment to the next successful one in the same repo and environment.
`series`	`any[][]`	[day (YYYY-MM-DD), successes, failures] per day with deployments.

curl https://work.nightroll.app/api/v1/git.dora \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

git.flag_linkwrite

REST POST /api/v1/git.flag_link · MCP tool git_flag_link · scopes git:write

Input

`connection`required	`integer`	A LaunchDarkly or Unleash connection.
`flag`required	`string`
`key`required	`string`	Issue key.
`linked`	`boolean`	false removes the link.

Output `object`

`branches`	`object[]`
`builds`	`object[]`	The latest run of each build (workflow, pipeline, status context), newest first.
`commits`	`object[]`	Newest first, at most 50.
`deployments`	`object[]`	The latest deployment to each environment, newest first.
`flags`	`object[]`	Feature flags (LaunchDarkly, Unleash) linked to the issue.
`prs`	`object[]`

curl https://work.nightroll.app/api/v1/git.flag_link \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"connection":1,"flag":"<flag>","key":"<key>"}'

git.ingestwrite

REST POST /api/v1/git.ingest · MCP tool git_ingest · scopes system

Input

`authors`	`object`	Members whose email the body mentions, `{email: {id, scopes, teams}}`, so smart commits act as their authors.
`body`required	`string`	The raw body, as received (the signature covers it byte for byte).
`connection`required	`integer`
`headers`required	`object`	Request headers, lowercase names.

Output `object`

`linked`	`string[]`
`result`	`string`	accepted \| ignored (an event this module doesn't use) \| refused (bad signature)

curl https://work.nightroll.app/api/v1/git.ingest \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","connection":1,"headers":"<headers>"}'

git.issueread

REST POST /api/v1/git.issue · MCP tool git_issue · scopes git:read

Input

keyrequired string

Output `object`

`branches`	`object[]`
`builds`	`object[]`	The latest run of each build (workflow, pipeline, status context), newest first.
`commits`	`object[]`	Newest first, at most 50.
`deployments`	`object[]`	The latest deployment to each environment, newest first.
`flags`	`object[]`	Feature flags (LaunchDarkly, Unleash) linked to the issue.
`prs`	`object[]`

curl https://work.nightroll.app/api/v1/git.issue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

git.reportwrite

REST POST /api/v1/git.report · MCP tool git_report · scopes git:write

Input

`branch`	`string`
`id`required	`string`	Your CI's id for this run or deployment; reporting the same id again updates it.
`keys`	`string[]`	Issue keys it delivers, besides those found in the branch, message and linked commits.
`kind`required	`string`	build \| deployment
`message`	`string`
`name`required	`string`	Build name (workflow, job), or the environment for a deployment.
`repo`required	`string`	Repository name (`acme/web`); builds and deployments reported through the API are grouped under it.
`sha`	`string`
`status`required	`string`	queued \| running \| success \| failure \| cancelled (pending for deployments); common CI words are mapped.
`url`	`string`

Output `object`

linked string[]

curl https://work.nightroll.app/api/v1/git.report \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>","kind":"<kind>","name":"<name>","repo":"<repo>","status":"<status>"}'

git.settingsread

REST POST /api/v1/git.settings · MCP tool git_settings · scopes git:read

Input

None: send {}.

Output `object`

`branch_template`	`string`	Branch name for "branch from issue": {key}, {summary} (the title as a slug), {type}, {project}.
`merge_status`	`string`	When a linked PR merges, move its issues to this status key ("" = don't; "@done" = the project's first done lane).
`pr_template`	`string`	Pull request title: {key}, {title}, {type}, {project}.
`production_envs`	`string`	Comma-separated environment names that count as production (DORA metrics, release badges).
`smart_commits`	`boolean`	Run `#comment`, `#time` and `#<transition>` commands in commit messages, as the member whose email wrote the commit.

curl https://work.nightroll.app/api/v1/git.settings \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

git.settings_savewrite

REST POST /api/v1/git.settings_save · MCP tool git_settings_save · scopes admin

Input

`branch_template`required	`string`	Branch name for "branch from issue": {key}, {summary} (the title as a slug), {type}, {project}.
`merge_status`required	`string`	When a linked PR merges, move its issues to this status key ("" = don't; "@done" = the project's first done lane).
`pr_template`required	`string`	Pull request title: {key}, {title}, {type}, {project}.
`production_envs`	`string`	Comma-separated environment names that count as production (DORA metrics, release badges).
`smart_commits`required	`boolean`	Run `#comment`, `#time` and `#<transition>` commands in commit messages, as the member whose email wrote the commit.

Output `object`

`branch_template`	`string`	Branch name for "branch from issue": {key}, {summary} (the title as a slug), {type}, {project}.
`merge_status`	`string`	When a linked PR merges, move its issues to this status key ("" = don't; "@done" = the project's first done lane).
`pr_template`	`string`	Pull request title: {key}, {title}, {type}, {project}.
`production_envs`	`string`	Comma-separated environment names that count as production (DORA metrics, release badges).
`smart_commits`	`boolean`	Run `#comment`, `#time` and `#<transition>` commands in commit messages, as the member whose email wrote the commit.

curl https://work.nightroll.app/api/v1/git.settings_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"branch_template":"<branch_template>","merge_status":"<merge_status>","pr_template":"<pr_template>","smart_commits":true}'

git.version_deploymentsread

REST POST /api/v1/git.version_deployments · MCP tool git_version_deployments · scopes git:read

Input

`project`required	`string`
`version`required	`integer`

Output `object[]`

`deployed`	`integer`	Of the version's fix issues, how many have a successful deployment here.
`environment`	`string`
`issues`	`integer`
`last_at`	`integer`
`last_status`	`string`
`production`	`boolean`

curl https://work.nightroll.app/api/v1/git.version_deployments \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>","version":1}'

imports

imports.cancelwrite

REST POST /api/v1/imports.cancel · MCP tool imports_cancel · scopes admin

Input

idrequired integer

Output `object`

`base_url`	`string`
`created_at`	`integer`
`created_by`	`string`
`error`	`string`
`finished_at`	`integer`
`id`	`integer`
`log`	`string[]`	The latest lines (≤ 200).
`name`	`string`
`options`	`any`
`pending`	`integer`	Requests still queued.
`source`	`string`	jira
`started_at`	`integer`
`state`	`string`	queued \| running \| done \| failed \| cancelled
`stats`	`any`	Counts so far (projects, issues, comments, attachments, …).

curl https://work.nightroll.app/api/v1/imports.cancel \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

imports.historyread

REST POST /api/v1/imports.history · MCP tool imports_history · scopes issues:read

Input

keyrequired string

Output `object[]`

`at`	`integer`
`author`	`string`
`field`	`string`
`from_value`	`string`
`to_value`	`string`

curl https://work.nightroll.app/api/v1/imports.history \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

imports.nextwrite

REST POST /api/v1/imports.next · MCP tool imports_next · scopes system

Input

runrequired integer

Output `object`

`binary`	`boolean`	Answer bytes as base64 (attachments).
`body`	`string`
`done`	`boolean`
`headers`	`any[][]`	[name, value] pairs, credentials included (cell-internal).
`method`	`string`
`task`	`integer`
`url`	`string`

curl https://work.nightroll.app/api/v1/imports.next \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"run":1}'

imports.resumewrite

REST POST /api/v1/imports.resume · MCP tool imports_resume · scopes system

Input

runrequired integer

Output `object`

done boolean

curl https://work.nightroll.app/api/v1/imports.resume \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"run":1}'

imports.runswrite

REST POST /api/v1/imports.runs · MCP tool imports_runs · scopes admin

Input

None: send {}.

Output `object[]`

`base_url`	`string`
`created_at`	`integer`
`created_by`	`string`
`error`	`string`
`finished_at`	`integer`
`id`	`integer`
`log`	`string[]`	The latest lines (≤ 200).
`name`	`string`
`options`	`any`
`pending`	`integer`	Requests still queued.
`source`	`string`	jira
`started_at`	`integer`
`state`	`string`	queued \| running \| done \| failed \| cancelled
`stats`	`any`	Counts so far (projects, issues, comments, attachments, …).

curl https://work.nightroll.app/api/v1/imports.runs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

imports.startwrite

REST POST /api/v1/imports.start · MCP tool imports_start · scopes admin

Input

`attachments`	`boolean`	Bring attachments (≤ 10 MB each).
`base_url`	`string`	The site, e.g. https://acme.atlassian.net or your Data Center address. Others: empty for the public service (or your GitHub Enterprise API address).
`email`	`string`	Jira/Confluence Cloud: your Atlassian account email (with an API token); Data Center: empty, with a personal access token. Trello: your API key (with a token).
`projects`	`string[]`	What to bring: Jira project keys, Confluence space keys, GitHub `owner/repo`s, Linear team keys, Trello board ids, Asana project ids. Empty = all the token can see (not for GitHub and Trello; Notion: every page shared with the integration, into one space named by the first entry).
`source`required	`string`	jira \| confluence \| github \| linear \| trello \| asana \| notion
`token`	`string`	Empty for a public site that allows anonymous reads.

Output `object`

`base_url`	`string`
`created_at`	`integer`
`created_by`	`string`
`error`	`string`
`finished_at`	`integer`
`id`	`integer`
`log`	`string[]`	The latest lines (≤ 200).
`name`	`string`
`options`	`any`
`pending`	`integer`	Requests still queued.
`source`	`string`	jira
`started_at`	`integer`
`state`	`string`	queued \| running \| done \| failed \| cancelled
`stats`	`any`	Counts so far (projects, issues, comments, attachments, …).

curl https://work.nightroll.app/api/v1/imports.start \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"source":"<source>"}'

imports.stepwrite

REST POST /api/v1/imports.step · MCP tool imports_step · scopes system

Input

`body`	`string`	Text, or base64 for binary tasks.
`error`	`string`	Why there was no answer.
`members`	`object`	The org's members `{email: id}`, to match people.
`run`required	`integer`
`status`required	`integer`	HTTP status (0 = no answer).
`task`required	`integer`
`teams`	`object`	The org's teams `{name: id}`, to match groups.

Output `object`

done boolean

curl https://work.nightroll.app/api/v1/imports.step \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"run":1,"status":1,"task":1}'

imports.sync_savewrite

REST POST /api/v1/imports.sync_save · MCP tool imports_sync_save · scopes admin

Input

`direction`	`string`	both \| in
`every`	`integer`
`id`required	`integer`
`paused`	`boolean`	Paused: nothing is polled or sent; changes made here wait in the queue.
`statuses`	`object`

Output `object`

`base_url`	`string`
`created_at`	`integer`
`created_by`	`string`
`error`	`string`
`finished_at`	`integer`
`id`	`integer`
`log`	`string[]`	The latest lines (≤ 200).
`name`	`string`
`options`	`any`
`pending`	`integer`	Requests still queued.
`source`	`string`	jira
`started_at`	`integer`
`state`	`string`	queued \| running \| done \| failed \| cancelled
`stats`	`any`	Counts so far (projects, issues, comments, attachments, …).

curl https://work.nightroll.app/api/v1/imports.sync_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

imports.sync_startwrite

REST POST /api/v1/imports.sync_start · MCP tool imports_sync_start · scopes admin

Input

`attachments`	`boolean`	Bring attachments (≤ 10 MB each).
`base_url`required	`string`	The Jira site: https://acme.atlassian.net or your Data Center address.
`direction`	`string`	both \| in (Jira → here only).
`email`	`string`	Cloud: your Atlassian account email (with an API token); Data Center: empty, with a personal access token.
`every`	`integer`	Seconds between polls (60–3600, default 120).
`jira_project`required	`string`	The Jira project key.
`project`	`string`	A project here to link instead (issues matched by number); empty = the Jira project is imported first.
`statuses`	`object`	Jira status name → lane name here, where they differ.
`token`	`string`	Needed to write to Jira; empty only for a read-only mirror (`direction: in`) of a public site.

Output `object`

`base_url`	`string`
`created_at`	`integer`
`created_by`	`string`
`error`	`string`
`finished_at`	`integer`
`id`	`integer`
`log`	`string[]`	The latest lines (≤ 200).
`name`	`string`
`options`	`any`
`pending`	`integer`	Requests still queued.
`source`	`string`	jira
`started_at`	`integer`
`state`	`string`	queued \| running \| done \| failed \| cancelled
`stats`	`any`	Counts so far (projects, issues, comments, attachments, …).

curl https://work.nightroll.app/api/v1/imports.sync_start \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"base_url":"<base_url>","jira_project":"<jira_project>"}'

imports.userswrite

REST POST /api/v1/imports.users · MCP tool imports_users · scopes admin

Input

runrequired integer

Output `object[]`

`email`	`string`
`ext`	`string`
`member`	`string`	The member they were matched to (by email), if any.
`name`	`string`

curl https://work.nightroll.app/api/v1/imports.users \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"run":1}'

incidents

incidents.declarewrite

REST POST /api/v1/incidents.declare · MCP tool incidents_declare · scopes incidents:write

Input

`commander`	`string`	Member id (default: whoever declares it).
`issues`	`string[]`	Issue keys it touches.
`severity`	`string`	A severity key (default: the least severe).
`summary`	`string`
`title`required	`string`

Output `object`

`incident`	`object`
`pages`	`any[][]`	Paging attempts: (provider name, action, state, error, at).
`timeline`	`object[]`

curl https://work.nightroll.app/api/v1/incidents.declare \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"title":"<title>"}'

incidents.getread

REST POST /api/v1/incidents.get · MCP tool incidents_get · scopes incidents:read

Input

idrequired integer

Output `object`

`incident`	`object`
`pages`	`any[][]`	Paging attempts: (provider name, action, state, error, at).
`timeline`	`object[]`

curl https://work.nightroll.app/api/v1/incidents.get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

incidents.linkwrite

REST POST /api/v1/incidents.link · MCP tool incidents_link · scopes incidents:write

Input

`id`required	`integer`
`key`required	`string`
`linked`	`boolean`	false unlinks.

Output `object`

`incident`	`object`
`pages`	`any[][]`	Paging attempts: (provider name, action, state, error, at).
`timeline`	`object[]`

curl https://work.nightroll.app/api/v1/incidents.link \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"key":"<key>"}'

incidents.listread

REST POST /api/v1/incidents.list · MCP tool incidents_list · scopes incidents:read

Input

open boolean Only open ones (not resolved).

Output `object[]`

`commander`	`string`	The incident commander (a member id).
`created_by`	`string`
`id`	`integer`
`issues`	`string[]`	Linked issue keys.
`last_update_at`	`integer`	When the last status update was posted.
`postmortem`	`string`	Its postmortem page (W706).
`resolved_at`	`integer`
`severity`	`string`
`started_at`	`integer`
`status`	`string`	investigating \| identified \| monitoring \| resolved
`summary`	`string`
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/incidents.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

incidents.notewrite

REST POST /api/v1/incidents.note · MCP tool incidents_note · scopes incidents:write

Input

`body`required	`string`
`id`required	`integer`

Output `object`

`incident`	`object`
`pages`	`any[][]`	Paging attempts: (provider name, action, state, error, at).
`timeline`	`object[]`

curl https://work.nightroll.app/api/v1/incidents.note \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","id":1}'

incidents.pagewrite

REST POST /api/v1/incidents.page · MCP tool incidents_page · scopes incidents:write

Input

idrequired integer

Output `object`

`incident`	`object`
`pages`	`any[][]`	Paging attempts: (provider name, action, state, error, at).
`timeline`	`object[]`

curl https://work.nightroll.app/api/v1/incidents.page \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

incidents.page_requestwrite

REST POST /api/v1/incidents.page_request · MCP tool incidents_page_request · scopes system

Input

idrequired integer

Output `object`

`body`	`string`
`gone`	`boolean`	Nothing to send (the pager or incident is gone).
`headers`	`any[][]`
`method`	`string`
`url`	`string`

curl https://work.nightroll.app/api/v1/incidents.page_request \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

incidents.page_resultwrite

REST POST /api/v1/incidents.page_result · MCP tool incidents_page_result · scopes system

Input

`body`	`string`
`error`	`string`
`id`required	`integer`
`status`required	`integer`

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/incidents.page_result \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"status":1}'

incidents.pager_deletedestructive

REST POST /api/v1/incidents.pager_delete · MCP tool incidents_pager_delete · scopes admin

Input

idrequired integer

Output `object[]`

`enabled`	`boolean`
`id`	`integer`
`last_error`	`string`
`name`	`string`
`provider`	`string`	pagerduty \| opsgenie
`region`	`string`	Opsgenie: us \| eu.
`severities`	`string[]`	Severities it pages for (empty = every severity marked “page”).

curl https://work.nightroll.app/api/v1/incidents.pager_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

incidents.pager_savewrite

REST POST /api/v1/incidents.pager_save · MCP tool incidents_pager_save · scopes admin

Input

`enabled`	`boolean`
`id`	`integer`
`key`	`string`	PagerDuty: an Events API v2 integration (routing) key. Opsgenie: an API integration key. Left out keeps it.
`name`	`string`
`provider`	`string`	pagerduty \| opsgenie
`region`	`string`
`severities`	`string[]`

Output `object[]`

`enabled`	`boolean`
`id`	`integer`
`last_error`	`string`
`name`	`string`
`provider`	`string`	pagerduty \| opsgenie
`region`	`string`	Opsgenie: us \| eu.
`severities`	`string[]`	Severities it pages for (empty = every severity marked “page”).

curl https://work.nightroll.app/api/v1/incidents.pager_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

incidents.pagerswrite

REST POST /api/v1/incidents.pagers · MCP tool incidents_pagers · scopes admin

Input

None: send {}.

Output `object[]`

`enabled`	`boolean`
`id`	`integer`
`last_error`	`string`
`name`	`string`
`provider`	`string`	pagerduty \| opsgenie
`region`	`string`	Opsgenie: us \| eu.
`severities`	`string[]`	Severities it pages for (empty = every severity marked “page”).

curl https://work.nightroll.app/api/v1/incidents.pagers \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

incidents.postmortemwrite

REST POST /api/v1/incidents.postmortem · MCP tool incidents_postmortem · scopes incidents:write

Input

`ai`	`boolean`	Let the org's AI draft the summary and a root-cause hypothesis.
`id`required	`integer`
`space`required	`string`	The pages space to write it in.

Output `object`

`ai_note`	`string`	Why the AI part was skipped, if it was.
`created`	`boolean`	Made now (false: the incident already had one).
`page`	`string`	The page (a draft until someone publishes it).

curl https://work.nightroll.app/api/v1/incidents.postmortem \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"space":"<space>"}'

incidents.severitiesread

REST POST /api/v1/incidents.severities · MCP tool incidents_severities · scopes incidents:read

Input

None: send {}.

Output `object[]`

`color`	`string`
`key`	`string`
`name`	`string`
`page`	`boolean`	Declaring (or raising to) this severity pages on-call.
`position`	`number`
`update_minutes`	`integer`	Remind the commander when no update was posted for this long (0 = never).

curl https://work.nightroll.app/api/v1/incidents.severities \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

incidents.severity_deletedestructive

REST POST /api/v1/incidents.severity_delete · MCP tool incidents_severity_delete · scopes admin

Input

keyrequired string

Output `object[]`

`color`	`string`
`key`	`string`
`name`	`string`
`page`	`boolean`	Declaring (or raising to) this severity pages on-call.
`position`	`number`
`update_minutes`	`integer`	Remind the commander when no update was posted for this long (0 = never).

curl https://work.nightroll.app/api/v1/incidents.severity_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

incidents.severity_savewrite

REST POST /api/v1/incidents.severity_save · MCP tool incidents_severity_save · scopes admin

Input

`color`	`string`
`key`	`string`	Omit to make one (from the name).
`name`required	`string`
`page`	`boolean`
`position`	`number`
`update_minutes`	`integer`

Output `object[]`

`color`	`string`
`key`	`string`
`name`	`string`
`page`	`boolean`	Declaring (or raising to) this severity pages on-call.
`position`	`number`
`update_minutes`	`integer`	Remind the commander when no update was posted for this long (0 = never).

curl https://work.nightroll.app/api/v1/incidents.severity_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>"}'

incidents.updatewrite

REST POST /api/v1/incidents.update · MCP tool incidents_update · scopes incidents:write

Input

`commander`	`string`	Member id; empty clears.
`id`required	`integer`
`message`	`string`	A status update for the timeline.
`public`	`boolean`	The update is public (for a status page); default true.
`severity`	`string`
`status`	`string`	investigating \| identified \| monitoring \| resolved
`summary`	`string`
`title`	`string`

Output `object`

`incident`	`object`
`pages`	`any[][]`	Paging attempts: (provider name, action, state, error, at).
`timeline`	`object[]`

curl https://work.nightroll.app/api/v1/incidents.update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues

issues.assignwrite

REST POST /api/v1/issues.assign · MCP tool issues_assign · scopes issues:write

Input

`assignee`required	`string`	Member id; empty string unassigns.
`base`	`string`	The assignee you saw (null = unassigned); see `issues.update` `base`.
`key`required	`string`

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.assign \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"assignee":"<assignee>","key":"<key>"}'

issues.board_getread

REST POST /api/v1/issues.board_get · MCP tool issues_board_get · scopes issues:read

Input

projectrequired string

Output `object`

`can_edit`	`boolean`	The caller may change this (project admins).
`card_fields`	`string[]`	Which of key, kind, priority, labels, epic, parent, points, assignee, due cards show.
`project`	`string`
`quick_filters`	`object[]`
`swimlanes`	`string`	none \| assignee \| epic \| priority
`wip`	`object`	Status key → most cards that column should hold (a warning, never a block).

curl https://work.nightroll.app/api/v1/issues.board_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.board_savewrite

REST POST /api/v1/issues.board_save · MCP tool issues_board_save · scopes issues:write

Input

`card_fields`required	`string[]`
`project`required	`string`
`quick_filters`required	`object[]`
`swimlanes`required	`string`
`wip`required	`object`

Output `object`

`can_edit`	`boolean`	The caller may change this (project admins).
`card_fields`	`string[]`	Which of key, kind, priority, labels, epic, parent, points, assignee, due cards show.
`project`	`string`
`quick_filters`	`object[]`
`swimlanes`	`string`	none \| assignee \| epic \| priority
`wip`	`object`	Status key → most cards that column should hold (a warning, never a block).

curl https://work.nightroll.app/api/v1/issues.board_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"card_fields":[],"project":"<project>","quick_filters":[],"swimlanes":"<swimlanes>","wip":"<wip>"}'

issues.bulkdestructive

REST POST /api/v1/issues.bulk · MCP tool issues_bulk · scopes issues:write

Input

`assignee`	`string`	Member id; "" unassigns.
`delete`	`boolean`	Delete them (sub-tasks go with their parents).
`dry_run`	`boolean`	Work it out and show what would change, then roll it all back.
`fields`	`object`	Custom field values to set on each.
`fix_versions_add`	`string[]`	Version names to add as fix versions.
`keys`required	`string[]`	Issue keys to change (max 500). All changes apply or none do.
`labels_add`	`string[]`
`labels_remove`	`string[]`
`move_to`	`string`	Move them to this project.
`parent`	`string`	Parent key; null clears.
`priority`	`string`
`resolution`	`string`
`sprint`	`integer`	Sprint id; null = backlog.
`status`	`string`

Output `object`

`deleted`	`integer`
`preview`	`object[]`	dry_run: what each affected issue would look like.
`undo`	`integer`	Pass to `issues.bulk_undo` until `undo_until` to put everything back.
`undo_until`	`integer`
`updated`	`string[]`	Keys after the change (moved issues have new keys).

curl https://work.nightroll.app/api/v1/issues.bulk \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"keys":[]}'

issues.bulk_undodestructive

REST POST /api/v1/issues.bulk_undo · MCP tool issues_bulk_undo · scopes issues:write

Input

`force`	`boolean`	Undo even over changes made to these issues since (they're lost).
`id`required	`integer`

Output `object`

restored string[] Issues put back as they were.

curl https://work.nightroll.app/api/v1/issues.bulk_undo \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.bulk_undosdestructive

REST POST /api/v1/issues.bulk_undos · MCP tool issues_bulk_undos · scopes issues:write

Input

None: send {}.

Output `object[]`

`created_at`	`integer`
`expires_at`	`integer`
`id`	`integer`
`summary`	`string`

curl https://work.nightroll.app/api/v1/issues.bulk_undos \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.burndownread

REST POST /api/v1/issues.burndown · MCP tool issues_burndown · scopes issues:read

Input

idrequired integer

Output `object`

`days`	`object[]`	One entry per day from the start through today (or the end); days without changes carry the last snapshot.
`sprint`	`object`

curl https://work.nightroll.app/api/v1/issues.burndown \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.calendar_feed_deleteread

REST POST /api/v1/issues.calendar_feed_delete · MCP tool issues_calendar_feed_delete · scopes issues:read

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/issues.calendar_feed_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.calendar_feed_rotateread

REST POST /api/v1/issues.calendar_feed_rotate · MCP tool issues_calendar_feed_rotate · scopes issues:read

Input

idrequired integer

Output `object`

`feed`	`object`
`path`	`string`	The feed's address after the site's: `/cal/{org}/{token}.ics`. Shown once; rotate to get a new one.

curl https://work.nightroll.app/api/v1/issues.calendar_feed_rotate \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.calendar_feed_saveread

REST POST /api/v1/issues.calendar_feed_save · MCP tool issues_calendar_feed_save · scopes issues:read

Input

`due`	`boolean`
`id`	`integer`
`name`	`string`
`projects`	`string[]`
`releases`	`boolean`
`sprints`	`boolean`
`tql`	`string`

Output `object`

`feed`	`object`
`path`	`string`	The feed's address after the site's: `/cal/{org}/{token}.ics`. Shown once; rotate to get a new one.

curl https://work.nightroll.app/api/v1/issues.calendar_feed_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.calendar_feedsread

REST POST /api/v1/issues.calendar_feeds · MCP tool issues_calendar_feeds · scopes issues:read

Input

None: send {}.

Output `object[]`

`created_at`	`integer`
`due`	`boolean`
`id`	`integer`
`last_fetched_at`	`integer`
`name`	`string`
`projects`	`string[]`	Sprints and releases of these projects (empty = every project you can see).
`releases`	`boolean`
`sprints`	`boolean`
`tql`	`string`	Which issues' due dates (empty = every issue you can see that has one).

curl https://work.nightroll.app/api/v1/issues.calendar_feeds \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.calendar_icsread

REST POST /api/v1/issues.calendar_ics · MCP tool issues_calendar_ics · scopes issues:read

Input

`origin`	`string`	The site's address, for issue links.
`token`required	`string`

Output `object`

ics string

curl https://work.nightroll.app/api/v1/issues.calendar_ics \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"token":"<token>"}'

issues.calendar_ownerwrite

REST POST /api/v1/issues.calendar_owner · MCP tool issues_calendar_owner · scopes system

Input

`origin`	`string`	The site's address, for issue links.
`token`required	`string`

Output `object`

member string

curl https://work.nightroll.app/api/v1/issues.calendar_owner \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"token":"<token>"}'

issues.carry_overwrite

REST POST /api/v1/issues.carry_over · MCP tool issues_carry_over · scopes issues:write

Input

keyrequired string

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.carry_over \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.clonewrite

REST POST /api/v1/issues.clone · MCP tool issues_clone · scopes issues:write

Input

`key`required	`string`
`links`	`boolean`	Copy the original's links (default false). The clone is always linked to it ("clones").
`subtasks`	`boolean`	Clone sub-tasks too (default true).
`title`	`string`	Defaults to "CLONE - <title>".

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.clone \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.component_deletedestructive

REST POST /api/v1/issues.component_delete · MCP tool issues_component_delete · scopes issues:write

Input

`id`required	`integer`
`move_to`	`integer`	Issues move to this version instead of losing it.

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.component_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.component_savewrite

REST POST /api/v1/issues.component_save · MCP tool issues_component_save · scopes issues:write

Input

`default_assignee`	`string`	Member id; "" clears.
`description`	`string`
`id`	`integer`	Omit to create.
`lead`	`string`	Member id; "" clears.
`name`	`string`
`project`	`string`	Required to create.

Output `object`

`default_assignee`	`string`	New issues with this component and no assignee go to this member.
`description`	`string`
`id`	`integer`
`issues`	`integer`	Issues with this component.
`lead`	`string`
`name`	`string`
`project`	`string`

curl https://work.nightroll.app/api/v1/issues.component_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.componentsread

REST POST /api/v1/issues.components · MCP tool issues_components · scopes issues:read

Input

projectrequired string

Output `object[]`

`default_assignee`	`string`	New issues with this component and no assignee go to this member.
`description`	`string`
`id`	`integer`
`issues`	`integer`	Issues with this component.
`lead`	`string`
`name`	`string`
`project`	`string`

curl https://work.nightroll.app/api/v1/issues.components \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.createwrite

REST POST /api/v1/issues.create · MCP tool issues_create · scopes issues:write

Input

`affects_versions`	`string[]`
`assignee`	`string`	Member id. Defaults to a component's default assignee.
`components`	`string[]`	Component names of the project.
`description`	`string`	Markdown (what search, TQL, mentions and agents read).
`description_doc`	`string`	The same description as a rich document (TipTap JSON, as the web editor writes it); optional.
`due_date`	`string`	YYYY-MM-DD
`fields`	`object`	Custom field values by field key (see `issues.fields`). Fields left out get their default.
`fix_versions`	`string[]`	Version names of the project.
`kind`	`string`	Defaults to the first type.
`labels`	`string[]`	Label keys.
`parent`	`string`	Key of the parent: an issue of the type one level up (a story's epic, a sub-task's story).
`points`	`number`
`priority`	`string`	Defaults to the last (least urgent) priority.
`project`required	`string`	Project key, e.g. "KB".
`security`	`integer`	Security level id (you must be one of its members).
`sprint`	`integer`	Ignored for sub-tasks, which follow their parent.
`start_date`	`string`	YYYY-MM-DD, on or before the due date (the timeline draws start → due).
`status`	`string`	A lane key of the project; defaults to its first "todo" lane.
`title`required	`string`

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>","title":"<title>"}'

issues.dashboard_deletedestructive

REST POST /api/v1/issues.dashboard_delete · MCP tool issues_dashboard_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.dashboard_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.dashboard_getread

REST POST /api/v1/issues.dashboard_get · MCP tool issues_dashboard_get · scopes issues:read

Input

idrequired integer

Output `object`

`can_edit`	`boolean`
`created_at`	`integer`
`editors`	`string[]`
`gadgets`	`object[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it (`everyone`, `admins`, `team:<id>`, member ids). Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.dashboard_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.dashboard_savewrite

REST POST /api/v1/issues.dashboard_save · MCP tool issues_dashboard_save · scopes issues:write

Input

`editors`	`string[]`
`gadgets`	`object[]`
`id`	`integer`
`name`required	`string`
`viewers`	`string[]`

Output `object`

`can_edit`	`boolean`
`created_at`	`integer`
`editors`	`string[]`
`gadgets`	`object[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it (`everyone`, `admins`, `team:<id>`, member ids). Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.dashboard_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>"}'

issues.dashboardsread

REST POST /api/v1/issues.dashboards · MCP tool issues_dashboards · scopes issues:read

Input

None: send {}.

Output `object[]`

`can_edit`	`boolean`
`created_at`	`integer`
`editors`	`string[]`
`gadgets`	`object[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it (`everyone`, `admins`, `team:<id>`, member ids). Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.dashboards \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.deletedestructive

REST POST /api/v1/issues.delete · MCP tool issues_delete · scopes issues:write

Input

keyrequired string Issue key, e.g. "KB-12". Keys from before a move still work.

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.field_deletedestructive

REST POST /api/v1/issues.field_delete · MCP tool issues_field_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.field_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.field_savewrite

REST POST /api/v1/issues.field_save · MCP tool issues_field_save · scopes admin

Input

`default_value`	`any`	null clears.
`description`	`string`
`formula`	`string`
`id`	`integer`	Omit to create.
`key`	`string`	Create only; derived from the name when omitted.
`kinds`	`string[]`
`name`	`string`
`options`	`object[]`
`position`	`number`
`projects`	`string[]`
`required`	`boolean`
`type`	`string`	Create only. text \| textarea \| number \| select \| multiselect \| cascade \| user \| users \| date \| url \| labels \| formula

Output `object`

`default_value`	`any`	Value new issues start with.
`description`	`string`
`formula`	`string`	Formula fields: arithmetic over number fields and `points`, e.g. `{reach} * {impact} / {points}`.
`id`	`integer`
`key`	`string`	Stable key used in `fields` on issues.
`kinds`	`string[]`	Issue type keys that use this field; empty = all.
`name`	`string`
`options`	`object[]`	Choices for select, multiselect and cascade.
`position`	`number`
`projects`	`string[]`	Project keys that use this field; empty = all.
`required`	`boolean`
`type`	`string`	text \| textarea \| number \| select \| multiselect \| cascade \| user \| users \| date \| url \| labels \| formula

curl https://work.nightroll.app/api/v1/issues.field_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.fieldsread

REST POST /api/v1/issues.fields · MCP tool issues_fields · scopes issues:read

Input

None: send {}.

Output `object[]`

`default_value`	`any`	Value new issues start with.
`description`	`string`
`formula`	`string`	Formula fields: arithmetic over number fields and `points`, e.g. `{reach} * {impact} / {points}`.
`id`	`integer`
`key`	`string`	Stable key used in `fields` on issues.
`kinds`	`string[]`	Issue type keys that use this field; empty = all.
`name`	`string`
`options`	`object[]`	Choices for select, multiselect and cascade.
`position`	`number`
`projects`	`string[]`	Project keys that use this field; empty = all.
`required`	`boolean`
`type`	`string`	text \| textarea \| number \| select \| multiselect \| cascade \| user \| users \| date \| url \| labels \| formula

curl https://work.nightroll.app/api/v1/issues.fields \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.filter_deletedestructive

REST POST /api/v1/issues.filter_delete · MCP tool issues_filter_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.filter_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.filter_runreadRuns a saved filter as the caller (their permissions apply), optionally within one project.

REST POST /api/v1/issues.filter_run · MCP tool issues_filter_run · scopes issues:read

Input

`id`required	`integer`
`limit`	`integer`
`offset`	`integer`
`project`	`string`	Only this project's issues (boards pass theirs).

Output `object`

`issues`	`object[]`
`limit`	`integer`
`offset`	`integer`
`total`	`integer`	Every match you can see.

curl https://work.nightroll.app/api/v1/issues.filter_run \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.filter_savewrite

REST POST /api/v1/issues.filter_save · MCP tool issues_filter_save · scopes issues:write

Input

`description`	`string`
`editors`	`string[]`
`id`	`integer`	Omit to create.
`name`	`string`
`tql`	`string`	TQL; checked when saved.
`viewers`	`string[]`

Output `object`

`can_edit`	`boolean`	The caller may change it.
`created_at`	`integer`
`description`	`string`
`editors`	`string[]`	Who else may change or delete it (same entries).
`id`	`integer`
`name`	`string`
`owner`	`string`
`tql`	`string`
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it: `everyone`, `admins`, `team:<id>`, member ids. Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.filter_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.filter_subsread

REST POST /api/v1/issues.filter_subs · MCP tool issues_filter_subs · scopes issues:read

Input

filter integer Only subscriptions to this filter.

Output `object[]`

`at`	`string`	HH:MM in the subscriber's own time.
`every`	`string`	daily \| weekdays \| weekly
`filter`	`integer`
`filter_name`	`string`
`id`	`integer`
`last_sent`	`string`	The subscriber's local date of the last email.
`skip_empty`	`boolean`	Send nothing when the filter matches no issues.
`tz_offset`	`integer`	Minutes behind UTC (the browser's `getTimezoneOffset()`).
`weekday`	`integer`	weekly: 0 Sunday … 6 Saturday.

curl https://work.nightroll.app/api/v1/issues.filter_subs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.filter_subscriberead

REST POST /api/v1/issues.filter_subscribe · MCP tool issues_filter_subscribe · scopes issues:read

Input

`at`required	`string`	HH:MM, 24-hour, your own time.
`every`required	`string`	daily \| weekdays \| weekly
`filter`required	`integer`
`id`	`integer`	Omit to subscribe; give one of yours to change it.
`skip_empty`	`boolean`
`tz_offset`	`integer`
`weekday`	`integer`	weekly: 0 Sunday … 6 Saturday (default Monday).

Output `object`

`at`	`string`	HH:MM in the subscriber's own time.
`every`	`string`	daily \| weekdays \| weekly
`filter`	`integer`
`filter_name`	`string`
`id`	`integer`
`last_sent`	`string`	The subscriber's local date of the last email.
`skip_empty`	`boolean`	Send nothing when the filter matches no issues.
`tz_offset`	`integer`	Minutes behind UTC (the browser's `getTimezoneOffset()`).
`weekday`	`integer`	weekly: 0 Sunday … 6 Saturday.

curl https://work.nightroll.app/api/v1/issues.filter_subscribe \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"at":"<at>","every":"<every>","filter":1}'

issues.filter_unsubscriberead

REST POST /api/v1/issues.filter_unsubscribe · MCP tool issues_filter_unsubscribe · scopes issues:read

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.filter_unsubscribe \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.filtersread

REST POST /api/v1/issues.filters · MCP tool issues_filters · scopes issues:read

Input

None: send {}.

Output `object[]`

`can_edit`	`boolean`	The caller may change it.
`created_at`	`integer`
`description`	`string`
`editors`	`string[]`	Who else may change or delete it (same entries).
`id`	`integer`
`name`	`string`
`owner`	`string`
`tql`	`string`
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it: `everyone`, `admins`, `team:<id>`, member ids. Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.filters \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.focusread

REST POST /api/v1/issues.focus · MCP tool issues_focus · scopes issues:read

Input

limit integer Default 10, max 50.

Output `object`

`due_today`	`integer`
`in_progress`	`integer`
`items`	`object[]`
`open`	`integer`	All open issues assigned to you (the list may be cut).
`overdue`	`integer`

curl https://work.nightroll.app/api/v1/issues.focus \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.gadgetread

REST POST /api/v1/issues.gadget · MCP tool issues_gadget · scopes issues:read

Input

`config`required	`object`
`type`required	`string`

Output `object`

`buckets`	`object[]`	pie.
`grid`	`object`	two_d.
`health`	`object`	sprint_health (null when no sprint is active).
`issues`	`object[]`	filter: the first rows.
`partial`	`boolean`
`series`	`object`	created_resolved.
`total`	`integer`	Matching issues counted, and whether there were more than the gadget reads.

curl https://work.nightroll.app/api/v1/issues.gadget \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"config":"<config>","type":"<type>"}'

issues.getread

REST POST /api/v1/issues.get · MCP tool issues_get · scopes issues:read

Input

keyrequired string Issue key, e.g. "KB-12". Keys from before a move still work.

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.goal_deletedestructive

REST POST /api/v1/issues.goal_delete · MCP tool issues_goal_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.goal_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.goal_getread

REST POST /api/v1/issues.goal_get · MCP tool issues_goal_get · scopes issues:read

Input

idrequired integer

Output `object`

`children`	`object[]`	Direct sub-goals (key results).
`goal`	`object`
`issues`	`object[]`	Linked issues the reader can see.

curl https://work.nightroll.app/api/v1/issues.goal_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.goal_linkwrite

REST POST /api/v1/issues.goal_link · MCP tool issues_goal_link · scopes issues:write

Input

`goal`required	`integer`
`key`required	`string`	Issue key (usually an epic).

Output `object`

`can_edit`	`boolean`
`description`	`string`
`done`	`number`
`editors`	`string[]`	Who else may change it (owner and admins always can).
`id`	`integer`
`linked`	`integer`	Linked issues the reader can see, and the standard issues under them (done / total, points when any).
`metric`	`object`	A number to move: progress is how far `current` has gone from `start` toward `target`.
`name`	`string`
`owner`	`string`
`parent`	`integer`	The objective this is a key result (or sub-goal) of.
`position`	`number`
`progress`	`integer`	0-100: the metric, the linked work, and sub-goals averaged.
`status`	`string`	A goal_status option key (On track, At risk, Off track, Achieved by default; configurable).
`target_date`	`string`	YYYY-MM-DD
`total`	`number`
`unit`	`string`	points \| issues
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/issues.goal_link \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"goal":1,"key":"<key>"}'

issues.goal_savewrite

REST POST /api/v1/issues.goal_save · MCP tool issues_goal_save · scopes issues:write

Input

`description`	`string`
`editors`	`string[]`
`id`	`integer`
`metric`	`object`	A number to move: progress is how far `current` has gone from `start` toward `target`.
`name`required	`string`
`owner`	`string`	Member id; default you.
`parent`	`integer`
`status`	`string`	goal_status key; default the first.
`target_date`	`string`

Output `object`

`can_edit`	`boolean`
`description`	`string`
`done`	`number`
`editors`	`string[]`	Who else may change it (owner and admins always can).
`id`	`integer`
`linked`	`integer`	Linked issues the reader can see, and the standard issues under them (done / total, points when any).
`metric`	`object`	A number to move: progress is how far `current` has gone from `start` toward `target`.
`name`	`string`
`owner`	`string`
`parent`	`integer`	The objective this is a key result (or sub-goal) of.
`position`	`number`
`progress`	`integer`	0-100: the metric, the linked work, and sub-goals averaged.
`status`	`string`	A goal_status option key (On track, At risk, Off track, Achieved by default; configurable).
`target_date`	`string`	YYYY-MM-DD
`total`	`number`
`unit`	`string`	points \| issues
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/issues.goal_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>"}'

issues.goal_unlinkwrite

REST POST /api/v1/issues.goal_unlink · MCP tool issues_goal_unlink · scopes issues:write

Input

`goal`required	`integer`
`key`required	`string`	Issue key (usually an epic).

Output `object`

`can_edit`	`boolean`
`description`	`string`
`done`	`number`
`editors`	`string[]`	Who else may change it (owner and admins always can).
`id`	`integer`
`linked`	`integer`	Linked issues the reader can see, and the standard issues under them (done / total, points when any).
`metric`	`object`	A number to move: progress is how far `current` has gone from `start` toward `target`.
`name`	`string`
`owner`	`string`
`parent`	`integer`	The objective this is a key result (or sub-goal) of.
`position`	`number`
`progress`	`integer`	0-100: the metric, the linked work, and sub-goals averaged.
`status`	`string`	A goal_status option key (On track, At risk, Off track, Achieved by default; configurable).
`target_date`	`string`	YYYY-MM-DD
`total`	`number`
`unit`	`string`	points \| issues
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/issues.goal_unlink \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"goal":1,"key":"<key>"}'

issues.goalsread

REST POST /api/v1/issues.goals · MCP tool issues_goals · scopes issues:read

Input

issue string Only goals this issue (key) is linked to.

Output `object[]`

`can_edit`	`boolean`
`description`	`string`
`done`	`number`
`editors`	`string[]`	Who else may change it (owner and admins always can).
`id`	`integer`
`linked`	`integer`	Linked issues the reader can see, and the standard issues under them (done / total, points when any).
`metric`	`object`	A number to move: progress is how far `current` has gone from `start` toward `target`.
`name`	`string`
`owner`	`string`
`parent`	`integer`	The objective this is a key result (or sub-goal) of.
`position`	`number`
`progress`	`integer`	0-100: the metric, the linked work, and sub-goals averaged.
`status`	`string`	A goal_status option key (On track, At risk, Off track, Achieved by default; configurable).
`target_date`	`string`	YYYY-MM-DD
`total`	`number`
`unit`	`string`	points \| issues
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/issues.goals \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.importwrite

REST POST /api/v1/issues.import · MCP tool issues_import · scopes issues:write

Input

`dry_run`	`boolean`	Validate everything, create nothing.
`project`required	`string`
`rows`required	`any[]`	One object per issue, with the fields of `issues.create` (title required; project defaults to `project`).

Output `object`

`created`	`string[]`	Keys created (in a dry run: the keys they would get).
`dry_run`	`boolean`
`errors`	`object[]`

curl https://work.nightroll.app/api/v1/issues.import \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>","rows":[]}'

issues.import_onewrite

REST POST /api/v1/issues.import_one · MCP tool issues_import_one · scopes admin

Input

`affects_versions`	`string[]`
`assignee`	`string`	Member ids.
`components`	`string[]`
`created_at`	`integer`	Unix seconds.
`created_by`	`string`
`description`	`string`
`due_date`	`string`
`fields`	`object`	Custom field values by field key.
`fix_versions`	`string[]`
`kind`	`string`	Names; made when the org doesn't have them.
`labels`	`string[]`
`number`	`integer`	The number it had (PROJ-123 → 123); taken or missing = the next free one.
`old_key`	`string`	Its key in the old tracker, when that differs from the new one: it keeps working.
`parent`	`string`	Key of an already imported parent.
`points`	`number`
`priority`	`string`
`project`required	`string`
`resolved_at`	`integer`
`sprint`	`object`
`status`	`string`
`status_category`	`string`	todo \| in_progress \| done, for a lane that has to be made.
`title`required	`string`
`updated_at`	`integer`

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.import_one \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>","title":"<title>"}'

issues.linkwrite

REST POST /api/v1/issues.link · MCP tool issues_link · scopes issues:write

Input

`key`required	`string`	The issue you're on.
`outward`required	`boolean`	true: `key` <outward> `target` ("KB-1 blocks KB-2"); false: `key` <inward> `target` ("KB-1 is blocked by KB-2").
`target`required	`string`
`type_id`required	`integer`	Link type id (`issues.link_types`).

Output `object[]`

`assignee`	`string`
`category`	`string`
`id`	`integer`
`key`	`string`
`kind`	`string`
`outward`	`boolean`	true when this issue is the link's source.
`phrase`	`string`	How this issue relates to `key`, e.g. "is blocked by".
`priority`	`string`
`status`	`string`
`title`	`string`
`type_id`	`integer`

curl https://work.nightroll.app/api/v1/issues.link \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","outward":true,"target":"<target>","type_id":1}'

issues.link_type_deletedestructive

REST POST /api/v1/issues.link_type_delete · MCP tool issues_link_type_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.link_type_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.link_type_savewrite

REST POST /api/v1/issues.link_type_save · MCP tool issues_link_type_save · scopes admin

Input

`id`	`integer`	Omit to create.
`inward`	`string`
`name`	`string`
`outward`	`string`

Output `object`

`id`	`integer`
`inward`	`string`	Phrase from the target: "is blocked by".
`name`	`string`
`outward`	`string`	Phrase from the source: "blocks".
`position`	`number`

curl https://work.nightroll.app/api/v1/issues.link_type_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.link_typesread

REST POST /api/v1/issues.link_types · MCP tool issues_link_types · scopes issues:read

Input

None: send {}.

Output `object[]`

`id`	`integer`
`inward`	`string`	Phrase from the target: "is blocked by".
`name`	`string`
`outward`	`string`	Phrase from the source: "blocks".
`position`	`number`

curl https://work.nightroll.app/api/v1/issues.link_types \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.linksread

REST POST /api/v1/issues.links · MCP tool issues_links · scopes issues:read

Input

keyrequired string

Output `object[]`

`assignee`	`string`
`category`	`string`
`id`	`integer`
`key`	`string`
`kind`	`string`
`outward`	`boolean`	true when this issue is the link's source.
`phrase`	`string`	How this issue relates to `key`, e.g. "is blocked by".
`priority`	`string`
`status`	`string`
`title`	`string`
`type_id`	`integer`

curl https://work.nightroll.app/api/v1/issues.links \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.listread

REST POST /api/v1/issues.list · MCP tool issues_list · scopes issues:read

Input

`assignee`	`string`
`backlog`	`boolean`	Only issues in no sprint.
`component`	`string`	Component or fix version name (with `project`).
`fix_version`	`string`
`label`	`string`
`parent`	`string`	Parent key: its children (an epic's issues, a story's sub-tasks).
`project`	`string`
`q`	`string`	Text in the key, title or description.
`sprint`	`integer`
`status`	`string`

Output `object[]`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.movewrite

REST POST /api/v1/issues.move · MCP tool issues_move · scopes issues:write

Input

`key`required	`string`
`project`required	`string`	Target project key.
`status`	`string`	Status in the target project; defaults to the same key if it exists there, else its first "todo" lane.

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.move \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","project":"<project>"}'

issues.option_deletedestructive

REST POST /api/v1/issues.option_delete · MCP tool issues_option_delete · scopes issues:write

Input

`id`required	`integer`
`replace_with`	`string`	Key that issues currently using this option move to. Required when any do.

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.option_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.option_reorderwrite

REST POST /api/v1/issues.option_reorder · MCP tool issues_option_reorder · scopes issues:write

Input

idsrequired integer[] Option ids of one list in their new order.

Output `object[]`

`category`	`string`	Statuses only: todo \| in_progress \| done. Drives "open", progress bars and dashboards.
`color`	`string`	Hex color, or empty.
`field`	`string`	status \| priority \| kind \| label \| retro \| resolution \| goal_status
`icon`	`string`	`glyph:<name>`, emoji/text, or a `data:image/…` URL; empty for none.
`id`	`integer`
`key`	`string`
`name`	`string`
`position`	`number`
`project`	`string`	Statuses: the project whose lane this is, or null for the org template new projects copy.
`rules`	`object`	Types only (empty defaults otherwise).

curl https://work.nightroll.app/api/v1/issues.option_reorder \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"ids":1}'

issues.option_savewrite

REST POST /api/v1/issues.option_save · MCP tool issues_option_save · scopes issues:write

Input

`category`	`string`	Statuses: todo \| in_progress \| done
`color`	`string`
`field`	`string`	status \| priority \| kind \| label \| retro \| resolution \| goal_status (create only)
`icon`	`string`
`id`	`integer`	Omit to create.
`key`	`string`	Stable key stored on issues; derived from the name when omitted (create only).
`name`	`string`
`position`	`number`	Defaults to the end of the list.
`project`	`string`	Statuses: project key for a project lane, omit for the org template (create only).
`rules`	`object`	Types only: replaces the type's rules.

Output `object`

`category`	`string`	Statuses only: todo \| in_progress \| done. Drives "open", progress bars and dashboards.
`color`	`string`	Hex color, or empty.
`field`	`string`	status \| priority \| kind \| label \| retro \| resolution \| goal_status
`icon`	`string`	`glyph:<name>`, emoji/text, or a `data:image/…` URL; empty for none.
`id`	`integer`
`key`	`string`
`name`	`string`
`position`	`number`
`project`	`string`	Statuses: the project whose lane this is, or null for the org template new projects copy.
`rules`	`object`	Types only (empty defaults otherwise).

curl https://work.nightroll.app/api/v1/issues.option_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.option_scheme_deletedestructive

REST POST /api/v1/issues.option_scheme_delete · MCP tool issues_option_scheme_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.option_scheme_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.option_scheme_savewrite

REST POST /api/v1/issues.option_scheme_save · MCP tool issues_option_scheme_save · scopes admin

Input

`default_key`	`string`
`field`required	`string`	priority \| resolution (fixed once created)
`id`	`integer`
`keys`required	`string[]`
`name`required	`string`

Output `object[]`

`default_key`	`string`	For new issues (priority) or when nothing else picks one (resolution); null = the usual (last priority, first resolution) among `keys`.
`field`	`string`	priority \| resolution
`id`	`integer`
`keys`	`string[]`	Option keys in it (shown in the org's order).
`name`	`string`
`projects`	`string[]`	Projects using it.

curl https://work.nightroll.app/api/v1/issues.option_scheme_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"field":"<field>","keys":[],"name":"<name>"}'

issues.option_schemesread

REST POST /api/v1/issues.option_schemes · MCP tool issues_option_schemes · scopes issues:read

Input

None: send {}.

Output `object[]`

`default_key`	`string`	For new issues (priority) or when nothing else picks one (resolution); null = the usual (last priority, first resolution) among `keys`.
`field`	`string`	priority \| resolution
`id`	`integer`
`keys`	`string[]`	Option keys in it (shown in the org's order).
`name`	`string`
`projects`	`string[]`	Projects using it.

curl https://work.nightroll.app/api/v1/issues.option_schemes \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.optionsread

REST POST /api/v1/issues.options · MCP tool issues_options · scopes issues:read

Input

None: send {}.

Output `object[]`

`category`	`string`	Statuses only: todo \| in_progress \| done. Drives "open", progress bars and dashboards.
`color`	`string`	Hex color, or empty.
`field`	`string`	status \| priority \| kind \| label \| retro \| resolution \| goal_status
`icon`	`string`	`glyph:<name>`, emoji/text, or a `data:image/…` URL; empty for none.
`id`	`integer`
`key`	`string`
`name`	`string`
`position`	`number`
`project`	`string`	Statuses: the project whose lane this is, or null for the org template new projects copy.
`rules`	`object`	Types only (empty defaults otherwise).

curl https://work.nightroll.app/api/v1/issues.options \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.planwrite

REST POST /api/v1/issues.plan · MCP tool issues_plan · scopes issues:write

Input

`keys`required	`string[]`	Issue keys.
`sprint`	`integer`	Target sprint; null = backlog.

Output `object[]`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.plan \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"keys":[]}'

issues.plan_baseline_deletedestructive

REST POST /api/v1/issues.plan_baseline_delete · MCP tool issues_plan_baseline_delete · scopes issues:write

Input

`baseline`required	`integer`
`plan`required	`integer`

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`dates`	`object`	Issue key → [start, due].
`id`	`integer`
`name`	`string`
`scenario`	`integer`	The scenario it was taken from (null = the live issues).

curl https://work.nightroll.app/api/v1/issues.plan_baseline_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"baseline":1,"plan":1}'

issues.plan_baseline_savewrite

REST POST /api/v1/issues.plan_baseline_save · MCP tool issues_plan_baseline_save · scopes issues:write

Input

`name`required	`string`
`plan`required	`integer`
`scenario`	`integer`	Snapshot this scenario's dates (default the live issues).

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`dates`	`object`	Issue key → [start, due].
`id`	`integer`
`name`	`string`
`scenario`	`integer`	The scenario it was taken from (null = the live issues).

curl https://work.nightroll.app/api/v1/issues.plan_baseline_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","plan":1}'

issues.plan_baselinesread

REST POST /api/v1/issues.plan_baselines · MCP tool issues_plan_baselines · scopes issues:read

Input

idrequired integer

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`dates`	`object`	Issue key → [start, due].
`id`	`integer`
`name`	`string`
`scenario`	`integer`	The scenario it was taken from (null = the live issues).

curl https://work.nightroll.app/api/v1/issues.plan_baselines \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.plan_changewrite

REST POST /api/v1/issues.plan_change · MCP tool issues_plan_change · scopes issues:write

Input

`assignee`	`string`
`discard`	`boolean`	Drop this issue's staged change instead.
`due_date`	`string`
`key`required	`string`
`plan`required	`integer`
`scenario`required	`integer`
`start_date`	`string`	The dates and assignee to stage (YYYY-MM-DD; assignee "" = unassign, omitted = unchanged).

Output `object`

count integer

curl https://work.nightroll.app/api/v1/issues.plan_change \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","plan":1,"scenario":1}'

issues.plan_commitwrite

REST POST /api/v1/issues.plan_commit · MCP tool issues_plan_commit · scopes issues:write

Input

`keys`	`string[]`	Only these issues (default all staged).
`plan`required	`integer`
`scenario`required	`integer`

Output `object`

count integer

curl https://work.nightroll.app/api/v1/issues.plan_commit \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"plan":1,"scenario":1}'

issues.plan_deletedestructive

REST POST /api/v1/issues.plan_delete · MCP tool issues_plan_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.plan_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.plan_ganttread

REST POST /api/v1/issues.plan_gantt · MCP tool issues_plan_gantt · scopes issues:read

Input

`baseline`	`integer`	Compare with this baseline.
`id`required	`integer`
`scenario`	`integer`

Output `object`

`baseline`	`object`	The chosen baseline's dates, and how many days each issue's due date has moved since (+ = later).
`critical`	`string[]`	Issues with no slack: a day's slip on any of them moves `finish`. In schedule order.
`finish`	`string`	Last due date of the plan's dated open work.
`slack`	`object`	Days each dated open issue can slip without moving `finish` (along "blocks" links).
`variance`	`object`

curl https://work.nightroll.app/api/v1/issues.plan_gantt \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.plan_savewrite

REST POST /api/v1/issues.plan_save · MCP tool issues_plan_save · scopes issues:write

Input

`editors`	`string[]`
`id`	`integer`
`name`required	`string`
`settings`required	`object`
`viewers`	`string[]`

Output `object`

`can_edit`	`boolean`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`scenarios`	`object[]`
`settings`	`object`
`updated_at`	`integer`
`viewers`	`string[]`

curl https://work.nightroll.app/api/v1/issues.plan_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","settings":"<settings>"}'

issues.plan_scenario_deletedestructive

REST POST /api/v1/issues.plan_scenario_delete · MCP tool issues_plan_scenario_delete · scopes issues:write

Input

`plan`required	`integer`
`scenario`required	`integer`

Output `object`

`can_edit`	`boolean`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`scenarios`	`object[]`
`settings`	`object`
`updated_at`	`integer`
`viewers`	`string[]`

curl https://work.nightroll.app/api/v1/issues.plan_scenario_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"plan":1,"scenario":1}'

issues.plan_scenario_savewrite

REST POST /api/v1/issues.plan_scenario_save · MCP tool issues_plan_scenario_save · scopes issues:write

Input

`copy_from`	`integer`	New scenarios start as a copy of this one's changes.
`id`	`integer`	Omit to add one.
`name`required	`string`
`plan`required	`integer`

Output `object`

`can_edit`	`boolean`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`scenarios`	`object[]`
`settings`	`object`
`updated_at`	`integer`
`viewers`	`string[]`

curl https://work.nightroll.app/api/v1/issues.plan_scenario_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","plan":1}'

issues.plan_schedulewrite

REST POST /api/v1/issues.plan_schedule · MCP tool issues_plan_schedule · scopes issues:write

Input

`plan`required	`integer`
`scenario`required	`integer`
`start`	`string`	First day work can start (default today).

Output `object`

count integer

curl https://work.nightroll.app/api/v1/issues.plan_schedule \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"plan":1,"scenario":1}'

issues.plan_viewread

REST POST /api/v1/issues.plan_view · MCP tool issues_plan_view · scopes issues:read

Input

`id`required	`integer`
`scenario`	`integer`	Show this scenario's staged changes; omit for the issues as they are.

Output `object`

`deps`	`object[]`
`items`	`object[]`
`load`	`object[]`	Work per person per week against their capacity.
`plan`	`object`
`scenario`	`integer`
`total`	`integer`	Matching issues (more than `items` when cut at 2,000).

curl https://work.nightroll.app/api/v1/issues.plan_view \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.plansread

REST POST /api/v1/issues.plans · MCP tool issues_plans · scopes issues:read

Input

None: send {}.

Output `object[]`

`can_edit`	`boolean`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`scenarios`	`object[]`
`settings`	`object`
`updated_at`	`integer`
`viewers`	`string[]`

curl https://work.nightroll.app/api/v1/issues.plans \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.project_createwrite

REST POST /api/v1/issues.project_create · MCP tool issues_project_create · scopes issues:write

Input

`color`	`string`
`copy_from`	`string`	Copy columns, workflow, components and board settings from this project…
`description`	`string`
`icon`	`string`
`key`required	`string`
`lead`	`string`	Project lead (member id): a default assignee and a workflow role.
`name`required	`string`
`style`	`string`	scrum (backlog and sprints) \| kanban (a continuous board). Default scrum.
`template`	`string`	…or start from a project template (key, see `issues.templates`). Neither = the org's default columns.

Output `object`

`admins`	`string[]`	Who changes settings, columns, workflow, components and versions.
`can_admin`	`boolean`
`can_edit`	`boolean`	What the caller may do.
`color`	`string`
`counts`	`object`	Issues per status category.
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`editors`	`string[]`	Who creates and changes issues, sprints and links.
`icon`	`string`
`key`	`string`
`lead`	`string`	Administers the project (as do org admins and anyone in `admins`).
`name`	`string`
`priority_scheme`	`integer`	Priority / resolution schemes in use; null = all the org's options.
`resolution_scheme`	`integer`
`scheme`	`integer`	Permission scheme in use (its lists replace the project's own); null = the project's own lists.
`style`	`string`	scrum \| kanban
`viewers`	`string[]`	Who sees the project and its issues: `everyone`, `admins`, `team:<id>`, member ids.

curl https://work.nightroll.app/api/v1/issues.project_create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","name":"<name>"}'

issues.project_deletedestructive

REST POST /api/v1/issues.project_delete · MCP tool issues_project_delete · scopes admin

Input

keyrequired string

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.project_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.project_getread

REST POST /api/v1/issues.project_get · MCP tool issues_project_get · scopes issues:read

Input

keyrequired string

Output `object`

`admins`	`string[]`	Who changes settings, columns, workflow, components and versions.
`can_admin`	`boolean`
`can_edit`	`boolean`	What the caller may do.
`color`	`string`
`counts`	`object`	Issues per status category.
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`editors`	`string[]`	Who creates and changes issues, sprints and links.
`icon`	`string`
`key`	`string`
`lead`	`string`	Administers the project (as do org admins and anyone in `admins`).
`name`	`string`
`priority_scheme`	`integer`	Priority / resolution schemes in use; null = all the org's options.
`resolution_scheme`	`integer`
`scheme`	`integer`	Permission scheme in use (its lists replace the project's own); null = the project's own lists.
`style`	`string`	scrum \| kanban
`viewers`	`string[]`	Who sees the project and its issues: `everyone`, `admins`, `team:<id>`, member ids.

curl https://work.nightroll.app/api/v1/issues.project_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.project_listread

REST POST /api/v1/issues.project_list · MCP tool issues_project_list · scopes issues:read

Input

None: send {}.

Output `object[]`

`admins`	`string[]`	Who changes settings, columns, workflow, components and versions.
`can_admin`	`boolean`
`can_edit`	`boolean`	What the caller may do.
`color`	`string`
`counts`	`object`	Issues per status category.
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`editors`	`string[]`	Who creates and changes issues, sprints and links.
`icon`	`string`
`key`	`string`
`lead`	`string`	Administers the project (as do org admins and anyone in `admins`).
`name`	`string`
`priority_scheme`	`integer`	Priority / resolution schemes in use; null = all the org's options.
`resolution_scheme`	`integer`
`scheme`	`integer`	Permission scheme in use (its lists replace the project's own); null = the project's own lists.
`style`	`string`	scrum \| kanban
`viewers`	`string[]`	Who sees the project and its issues: `everyone`, `admins`, `team:<id>`, member ids.

curl https://work.nightroll.app/api/v1/issues.project_list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.project_optionsread

REST POST /api/v1/issues.project_options · MCP tool issues_project_options · scopes issues:read

Input

projectrequired string

Output `object`

`default_priority`	`string`
`default_resolution`	`string`
`priorities`	`string[]`	Allowed keys in order; the default for new issues / resolving.
`resolutions`	`string[]`

curl https://work.nightroll.app/api/v1/issues.project_options \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.project_updatewrite

REST POST /api/v1/issues.project_update · MCP tool issues_project_update · scopes issues:write

Input

`admins`	`string[]`
`color`	`string`
`description`	`string`
`editors`	`string[]`
`icon`	`string`
`key`required	`string`
`lead`	`string`	Member id; empty clears.
`name`	`string`
`priority_scheme`	`integer`	Priority / resolution scheme (`issues.option_schemes`); null = all the org's options.
`resolution_scheme`	`integer`
`scheme`	`integer`	Use a shared permission scheme; null = back to the project's own lists.
`style`	`string`
`viewers`	`string[]`	Permission lists (`everyone`, `admins`, `team:<id>`, member ids).

Output `object`

`admins`	`string[]`	Who changes settings, columns, workflow, components and versions.
`can_admin`	`boolean`
`can_edit`	`boolean`	What the caller may do.
`color`	`string`
`counts`	`object`	Issues per status category.
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`editors`	`string[]`	Who creates and changes issues, sprints and links.
`icon`	`string`
`key`	`string`
`lead`	`string`	Administers the project (as do org admins and anyone in `admins`).
`name`	`string`
`priority_scheme`	`integer`	Priority / resolution schemes in use; null = all the org's options.
`resolution_scheme`	`integer`
`scheme`	`integer`	Permission scheme in use (its lists replace the project's own); null = the project's own lists.
`style`	`string`	scrum \| kanban
`viewers`	`string[]`	Who sees the project and its issues: `everyone`, `admins`, `team:<id>`, member ids.

curl https://work.nightroll.app/api/v1/issues.project_update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.queryreadIssues matching a TQL query (JQL-style), e.g. `project = KB AND status != Done AND assignee = currentUser() ORDER BY priority DESC`. Fields: project, key, summary, description, text (~ only), status, statusCategory, priority, type, resolution, assignee, reporter, labels, component, fixVersion, affectedVersion, sprint, parent, epic, created, updated, resolved, due, points, votes, watchers, and custom fields by key or name (quote names with spaces). Operators: = != > >= < <= ~ (contains) !~ IN (...) NOT IN (...) IS [NOT] EMPTY; AND, OR, NOT, parentheses. Functions: currentUser(), openSprints(), closedSprints(), futureSprints(), releasedVersions(), unreleasedVersions(), now(), startOfDay(), endOfDay(), startOfWeek(), startOfMonth(), startOfYear(); relative dates like -7d, -2w, 3h.

Issues matching a TQL query (JQL-style), e.g. `project = KB AND status != Done AND assignee = currentUser() ORDER BY priority DESC`. Fields: project, key, summary, description, text (~ only), status, statusCategory, priority, type, resolution, assignee, reporter, labels, component, fixVersion, affectedVersion, sprint, parent, epic, created, updated, resolved, due, points, votes, watchers, and custom fields by key or name (quote names with spaces). Operators: = != > >= < <= ~ (contains) !~ IN (...) NOT IN (...) IS [NOT] EMPTY; AND, OR, NOT, parentheses. Functions: currentUser(), openSprints(), closedSprints(), futureSprints(), releasedVersions(), unreleasedVersions(), now(), startOfDay(), endOfDay(), startOfWeek(), startOfMonth(), startOfYear(); relative dates like -7d, -2w, 3h.

REST POST /api/v1/issues.query · MCP tool issues_query · scopes issues:read

Input

`limit`	`integer`	1-500, default 50.
`offset`	`integer`
`tql`required	`string`

Output `object`

`issues`	`object[]`
`limit`	`integer`
`offset`	`integer`
`total`	`integer`	Every match you can see.

curl https://work.nightroll.app/api/v1/issues.query \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"tql":"<tql>"}'

issues.rankwrite

REST POST /api/v1/issues.rank · MCP tool issues_rank · scopes issues:write

Input

`after`	`string`	…or just below this one. Neither = the top.
`before`	`string`	Put it just above this issue (same project)…
`key`required	`string`

Output `object`

`key`	`string`
`rank`	`string`

curl https://work.nightroll.app/api/v1/issues.rank \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.recur_setwrite

REST POST /api/v1/issues.recur_set · MCP tool issues_recur_set · scopes issues:write

Input

`every`	`string`	day \| week \| month; null stops recurring.
`key`required	`string`
`next_on`	`string`	First date to create a copy (YYYY-MM-DD); defaults to one period from today.

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.recur_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.recur_tickwrite

REST POST /api/v1/issues.recur_tick · MCP tool issues_recur_tick · scopes admin

Input

None: send {}.

Output `object`

created string[]

curl https://work.nightroll.app/api/v1/issues.recur_tick \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.recurringread

REST POST /api/v1/issues.recurring · MCP tool issues_recurring · scopes issues:read

Input

None: send {}.

Output `object[]`

`every`	`string`
`key`	`string`
`next_on`	`string`
`title`	`string`

curl https://work.nightroll.app/api/v1/issues.recurring \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.release_notesread

REST POST /api/v1/issues.release_notes · MCP tool issues_release_notes · scopes issues:read

Input

`group_by`	`string`	type (default) \| component \| none
`include_open`	`boolean`	Include fix-version issues that aren't done yet (default false).
`version`required	`integer`	Version id.

Output `object`

`issues`	`integer`	Issues in the notes.
`markdown`	`string`	Markdown.

curl https://work.nightroll.app/api/v1/issues.release_notes \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"version":1}'

issues.release_notes_airead

REST POST /api/v1/issues.release_notes_ai · MCP tool issues_release_notes_ai · scopes issues:read

Input

`include_open`	`boolean`
`model`	`string`
`provider`	`string`
`tone`	`string`
`version`required	`integer`

Output `object`

`issues`	`integer`	Issues in the notes.
`markdown`	`string`	Markdown.

curl https://work.nightroll.app/api/v1/issues.release_notes_ai \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"version":1}'

issues.release_notes_promptread

REST POST /api/v1/issues.release_notes_prompt · MCP tool issues_release_notes_prompt · scopes issues:read

Input

`include_open`	`boolean`
`tone`	`string`	e.g. "friendly, for customers" (default) or "technical, for developers".
`version`required	`integer`

Output `object`

`prompt`	`string`
`subjects`	`string[]`
`system`	`string`

curl https://work.nightroll.app/api/v1/issues.release_notes_prompt \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"version":1}'

issues.release_notes_publishwrite

REST POST /api/v1/issues.release_notes_publish · MCP tool issues_release_notes_publish · scopes issues:write

Input

`space`required	`string`	Space key to publish into.
`title`	`string`	Default "<project> <version> release notes".
`version`required	`integer`

Output `object`

`page`	`string`	The page's id.
`title`	`string`

curl https://work.nightroll.app/api/v1/issues.release_notes_publish \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"space":"<space>","version":1}'

issues.release_notes_savewrite

REST POST /api/v1/issues.release_notes_save · MCP tool issues_release_notes_save · scopes issues:write

Input

`notes`required	`string`	Markdown.
`version`required	`integer`

Output `object`

`description`	`string`
`done`	`integer`
`id`	`integer`
`issues`	`integer`	Issues with this fix version, and how many of them are done.
`name`	`string`
`notes`	`string`	Saved release notes (markdown).
`project`	`string`
`release_date`	`string`
`released`	`boolean`
`released_at`	`integer`
`start_date`	`string`	YYYY-MM-DD

curl https://work.nightroll.app/api/v1/issues.release_notes_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"notes":"<notes>","version":1}'

issues.report_cycleread

REST POST /api/v1/issues.report_cycle · MCP tool issues_report_cycle · scopes issues:read

Input

`days`	`integer`	Days back from today (default 30 for flow, 90 for cycle time; at most 365).
`project`required	`string`

Output `object`

`cycle`	`object`	Started → resolved.
`items`	`object[]`	Issues resolved in the window, oldest first: the control chart's points.
`lead`	`object`	Created → resolved.

curl https://work.nightroll.app/api/v1/issues.report_cycle \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.report_flowread

REST POST /api/v1/issues.report_flow · MCP tool issues_report_flow · scopes issues:read

Input

`days`	`integer`	Days back from today (default 30 for flow, 90 for cycle time; at most 365).
`project`required	`string`

Output `object`

`counts`	`integer[][]`	counts[d][s]: issues in `statuses[s]` at the end of `days[d]`.
`days`	`string[]`	YYYY-MM-DD (UTC), oldest first.
`statuses`	`object[]`	The project's columns, in board order.

curl https://work.nightroll.app/api/v1/issues.report_flow \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.retro_addwrite

REST POST /api/v1/issues.retro_add · MCP tool issues_retro_add · scopes issues:write

Input

`anonymous`	`boolean`	Hide the author from everyone (the server keeps it only so they can remove the card).
`body`required	`string`
`col`required	`string`
`sprint`required	`integer`

Output `object`

`anonymous`	`boolean`
`author`	`string`	null on anonymous cards.
`body`	`string`
`col`	`string`	Retro column key (org-configurable, field "retro").
`created_at`	`integer`
`id`	`integer`
`mine`	`boolean`	The caller wrote it (true on your own anonymous cards too, so you can remove them).
`sprint`	`integer`
`voted`	`boolean`	Whether the caller voted.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/issues.retro_add \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","col":"<col>","sprint":1}'

issues.retro_deletedestructive

REST POST /api/v1/issues.retro_delete · MCP tool issues_retro_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.retro_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.retro_listread

REST POST /api/v1/issues.retro_list · MCP tool issues_retro_list · scopes issues:read

Input

idrequired integer

Output `object[]`

`anonymous`	`boolean`
`author`	`string`	null on anonymous cards.
`body`	`string`
`col`	`string`	Retro column key (org-configurable, field "retro").
`created_at`	`integer`
`id`	`integer`
`mine`	`boolean`	The caller wrote it (true on your own anonymous cards too, so you can remove them).
`sprint`	`integer`
`voted`	`boolean`	Whether the caller voted.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/issues.retro_list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.retro_votewrite

REST POST /api/v1/issues.retro_vote · MCP tool issues_retro_vote · scopes issues:write

Input

idrequired integer

Output `object`

`anonymous`	`boolean`
`author`	`string`	null on anonymous cards.
`body`	`string`
`col`	`string`	Retro column key (org-configurable, field "retro").
`created_at`	`integer`
`id`	`integer`
`mine`	`boolean`	The caller wrote it (true on your own anonymous cards too, so you can remove them).
`sprint`	`integer`
`voted`	`boolean`	Whether the caller voted.
`votes`	`integer`

curl https://work.nightroll.app/api/v1/issues.retro_vote \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.scheme_deletedestructive

REST POST /api/v1/issues.scheme_delete · MCP tool issues_scheme_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.scheme_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.scheme_savewrite

REST POST /api/v1/issues.scheme_save · MCP tool issues_scheme_save · scopes admin

Input

`admins`	`string[]`
`description`	`string`
`editors`	`string[]`
`id`	`integer`	Omit to create.
`name`	`string`
`viewers`	`string[]`

Output `object`

`admins`	`string[]`
`description`	`string`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`projects`	`string[]`	Keys of projects using it.
`viewers`	`string[]`

curl https://work.nightroll.app/api/v1/issues.scheme_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.schemesread

REST POST /api/v1/issues.schemes · MCP tool issues_schemes · scopes issues:read

Input

None: send {}.

Output `object[]`

`admins`	`string[]`
`description`	`string`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`projects`	`string[]`	Keys of projects using it.
`viewers`	`string[]`

curl https://work.nightroll.app/api/v1/issues.schemes \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.security_deletedestructive

REST POST /api/v1/issues.security_delete · MCP tool issues_security_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.security_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.security_levelsread

REST POST /api/v1/issues.security_levels · MCP tool issues_security_levels · scopes issues:read

Input

None: send {}.

Output `object[]`

`description`	`string`
`id`	`integer`
`issues`	`integer`	Issues at this level.
`members`	`string[]`	Who sees issues at this level (besides each issue's reporter and assignee, and org admins).
`mine`	`boolean`	Whether the caller is a member (may put issues at this level).
`name`	`string`
`position`	`number`

curl https://work.nightroll.app/api/v1/issues.security_levels \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.security_savewrite

REST POST /api/v1/issues.security_save · MCP tool issues_security_save · scopes admin

Input

`description`	`string`
`id`	`integer`
`members`	`string[]`
`name`	`string`
`position`	`number`

Output `object`

`description`	`string`
`id`	`integer`
`issues`	`integer`	Issues at this level.
`members`	`string[]`	Who sees issues at this level (besides each issue's reporter and assignee, and org admins).
`mine`	`boolean`	Whether the caller is a member (may put issues at this level).
`name`	`string`
`position`	`number`

curl https://work.nightroll.app/api/v1/issues.security_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.similarread

REST POST /api/v1/issues.similar · MCP tool issues_similar · scopes issues:read

Input

`key`	`string`	The issue itself, left out of its own matches.
`limit`	`integer`	Default 5, max 20.
`project`	`string`	Same-project matches come first.
`title`required	`string`

Output `object[]`

`assignee`	`string`
`category`	`string`	open \| done
`key`	`string`
`status`	`string`
`title`	`string`

curl https://work.nightroll.app/api/v1/issues.similar \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"title":"<title>"}'

issues.socialread

REST POST /api/v1/issues.social · MCP tool issues_social · scopes issues:read

Input

keyrequired string

Output `object`

`voted`	`boolean`
`votes`	`integer`
`watchers`	`string[]`	Watcher ids.
`watching`	`boolean`

curl https://work.nightroll.app/api/v1/issues.social \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.sprint_completewrite

REST POST /api/v1/issues.sprint_complete · MCP tool issues_sprint_complete · scopes issues:write

Input

`id`required	`integer`
`move_to`	`integer`	A planned sprint of the same project that unfinished issues move to; omit for the backlog.

Output `object`

`committed_points`	`number`	Points in the sprint when it started (velocity: committed).
`completed_at`	`integer`
`completed_points`	`number`	Points done when it completed (velocity: completed).
`created_at`	`integer`
`done_issues`	`integer`
`done_points`	`number`
`end_date`	`string`
`goal`	`string`
`id`	`integer`
`issues`	`integer`	Current contents.
`name`	`string`
`points`	`number`
`project`	`string`
`start_date`	`string`	YYYY-MM-DD
`state`	`string`	planned \| active \| closed

curl https://work.nightroll.app/api/v1/issues.sprint_complete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.sprint_deletedestructive

REST POST /api/v1/issues.sprint_delete · MCP tool issues_sprint_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.sprint_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.sprint_getread

REST POST /api/v1/issues.sprint_get · MCP tool issues_sprint_get · scopes issues:read

Input

idrequired integer

Output `object`

`committed_points`	`number`	Points in the sprint when it started (velocity: committed).
`completed_at`	`integer`
`completed_points`	`number`	Points done when it completed (velocity: completed).
`created_at`	`integer`
`done_issues`	`integer`
`done_points`	`number`
`end_date`	`string`
`goal`	`string`
`id`	`integer`
`issues`	`integer`	Current contents.
`name`	`string`
`points`	`number`
`project`	`string`
`start_date`	`string`	YYYY-MM-DD
`state`	`string`	planned \| active \| closed

curl https://work.nightroll.app/api/v1/issues.sprint_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.sprint_listread

REST POST /api/v1/issues.sprint_list · MCP tool issues_sprint_list · scopes issues:read

Input

projectrequired string

Output `object[]`

`committed_points`	`number`	Points in the sprint when it started (velocity: committed).
`completed_at`	`integer`
`completed_points`	`number`	Points done when it completed (velocity: completed).
`created_at`	`integer`
`done_issues`	`integer`
`done_points`	`number`
`end_date`	`string`
`goal`	`string`
`id`	`integer`
`issues`	`integer`	Current contents.
`name`	`string`
`points`	`number`
`project`	`string`
`start_date`	`string`	YYYY-MM-DD
`state`	`string`	planned \| active \| closed

curl https://work.nightroll.app/api/v1/issues.sprint_list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.sprint_reportread

REST POST /api/v1/issues.sprint_report · MCP tool issues_sprint_report · scopes issues:read

Input

idrequired integer

Output `object`

`added`	`object[]`	Put into the sprint after it started.
`completed`	`object[]`	Done (in a done column) and still in the sprint.
`not_completed`	`object[]`	Still open in the sprint, or (closed sprints) moved out when it completed.
`removed`	`object[]`	Taken out while it ran (not counting the move at completion).

curl https://work.nightroll.app/api/v1/issues.sprint_report \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.sprint_savewrite

REST POST /api/v1/issues.sprint_save · MCP tool issues_sprint_save · scopes issues:write

Input

`end_date`	`string`
`goal`	`string`
`id`	`integer`	Omit to create.
`name`	`string`	Defaults to "{KEY} Sprint {n}".
`project`	`string`	Required to create.
`start_date`	`string`

Output `object`

`committed_points`	`number`	Points in the sprint when it started (velocity: committed).
`completed_at`	`integer`
`completed_points`	`number`	Points done when it completed (velocity: completed).
`created_at`	`integer`
`done_issues`	`integer`
`done_points`	`number`
`end_date`	`string`
`goal`	`string`
`id`	`integer`
`issues`	`integer`	Current contents.
`name`	`string`
`points`	`number`
`project`	`string`
`start_date`	`string`	YYYY-MM-DD
`state`	`string`	planned \| active \| closed

curl https://work.nightroll.app/api/v1/issues.sprint_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.sprint_startwrite

REST POST /api/v1/issues.sprint_start · MCP tool issues_sprint_start · scopes issues:write

Input

`end_date`	`string`	Defaults to the planned date, else two weeks after the start.
`id`required	`integer`
`start_date`	`string`	Defaults to the planned date, else today.

Output `object`

`committed_points`	`number`	Points in the sprint when it started (velocity: committed).
`completed_at`	`integer`
`completed_points`	`number`	Points done when it completed (velocity: completed).
`created_at`	`integer`
`done_issues`	`integer`
`done_points`	`number`
`end_date`	`string`
`goal`	`string`
`id`	`integer`
`issues`	`integer`	Current contents.
`name`	`string`
`points`	`number`
`project`	`string`
`start_date`	`string`	YYYY-MM-DD
`state`	`string`	planned \| active \| closed

curl https://work.nightroll.app/api/v1/issues.sprint_start \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.standupread

REST POST /api/v1/issues.standup · MCP tool issues_standup · scopes issues:read

Input

`day`	`string`	YYYY-MM-DD, the reader's own date (default today, UTC).
`project`required	`string`

Output `object`

`day`	`string`
`people`	`object[]`	Everyone with sprint work or a statement today, busiest first (the order to go round in).
`sprint`	`integer`	Active sprint id, if one runs.

curl https://work.nightroll.app/api/v1/issues.standup \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.standup_savewrite

REST POST /api/v1/issues.standup_save · MCP tool issues_standup_save · scopes issues:write

Input

`blockers`required	`string`
`day`	`string`
`project`required	`string`
`today`required	`string`
`yesterday`required	`string`

Output `object`

`day`	`string`
`people`	`object[]`	Everyone with sprint work or a statement today, busiest first (the order to go round in).
`sprint`	`integer`	Active sprint id, if one runs.

curl https://work.nightroll.app/api/v1/issues.standup_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"blockers":"<blockers>","project":"<project>","today":"<today>","yesterday":"<yesterday>"}'

issues.structure_deletedestructive

REST POST /api/v1/issues.structure_delete · MCP tool issues_structure_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.structure_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.structure_getread

REST POST /api/v1/issues.structure_get · MCP tool issues_structure_get · scopes issues:read

Input

idrequired integer

Output `object`

`can_edit`	`boolean`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`source`	`object`	Where a structure's rows come from.
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it (`everyone`, `admins`, `team:<id>`, member ids). Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.structure_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.structure_savewrite

REST POST /api/v1/issues.structure_save · MCP tool issues_structure_save · scopes issues:write

Input

`editors`	`string[]`
`id`	`integer`
`name`required	`string`
`source`required	`object`	Where a structure's rows come from.
`viewers`	`string[]`

Output `object`

`can_edit`	`boolean`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`source`	`object`	Where a structure's rows come from.
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it (`everyone`, `admins`, `team:<id>`, member ids). Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.structure_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","source":"<source>"}'

issues.structure_treereadWhere a structure's rows come from.

REST POST /api/v1/issues.structure_tree · MCP tool issues_structure_tree · scopes issues:read

Input

`depth`	`integer`	Levels below the roots, 1-6 (default 3).
`expand`	`string`	How rows expand: children (hierarchy) \| links \| both \| none.
`link_type`	`integer`	links: only this link type (id, outward direction); empty = every type.
`sum_fields`	`string[]`	Number custom fields (keys) to sum next to points.
`tql`required	`string`	TQL for the top-level rows (≤500).

Output `object`

`partial`	`boolean`	Cut at the row or root limit.
`rows`	`object[]`
`total_roots`	`integer`	Roots matched by the TQL (they may be more than shown).

curl https://work.nightroll.app/api/v1/issues.structure_tree \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"tql":"<tql>"}'

issues.structuresread

REST POST /api/v1/issues.structures · MCP tool issues_structures · scopes issues:read

Input

None: send {}.

Output `object[]`

`can_edit`	`boolean`
`editors`	`string[]`
`id`	`integer`
`name`	`string`
`owner`	`string`
`source`	`object`	Where a structure's rows come from.
`updated_at`	`integer`
`viewers`	`string[]`	Who else sees it (`everyone`, `admins`, `team:<id>`, member ids). Empty = only the owner.

curl https://work.nightroll.app/api/v1/issues.structures \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.template_deletedestructive

REST POST /api/v1/issues.template_delete · MCP tool issues_template_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.template_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.template_savewrite

REST POST /api/v1/issues.template_save · MCP tool issues_template_save · scopes admin

Input

`config`	`object`	…or give them.
`description`	`string`
`from_project`	`string`	Take the columns, workflow, components and board from this project…
`id`	`integer`	Omit to add one.
`name`required	`string`
`style`required	`string`	scrum \| kanban

Output `object[]`

`config`	`object`
`description`	`string`
`id`	`integer`
`key`	`string`
`name`	`string`
`position`	`number`
`style`	`string`	scrum \| kanban

curl https://work.nightroll.app/api/v1/issues.template_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","style":"<style>"}'

issues.templatesread

REST POST /api/v1/issues.templates · MCP tool issues_templates · scopes issues:read

Input

None: send {}.

Output `object[]`

`config`	`object`
`description`	`string`
`id`	`integer`
`key`	`string`
`name`	`string`
`position`	`number`
`style`	`string`	scrum \| kanban

curl https://work.nightroll.app/api/v1/issues.templates \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.timelineread

REST POST /api/v1/issues.timeline · MCP tool issues_timeline · scopes issues:read

Input

projectrequired string

Output `object`

`can_edit`	`boolean`	The caller can reschedule (edit the project's issues).
`deps`	`object[]`
`items`	`object[]`	Epics (level ≥ 1, highest first) and their children, in rank order; `parent` gives the nesting.
`levels`	`object`	Hierarchy level per type key (types missing here are level 0).

curl https://work.nightroll.app/api/v1/issues.timeline \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.transition_deletedestructive

REST POST /api/v1/issues.transition_delete · MCP tool issues_transition_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.transition_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.transition_savewrite

REST POST /api/v1/issues.transition_save · MCP tool issues_transition_save · scopes issues:write

Input

`from_status`	`string`	Status key, or null / "" for any status.
`id`	`integer`	Omit to create.
`name`	`string`	Defaults to the target status's name.
`project`	`string`	Required to create.
`rules`	`object`
`to_status`	`string`

Output `object`

`from_status`	`string`	null = from any status.
`id`	`integer`
`name`	`string`
`position`	`number`
`project`	`string`
`rules`	`object`
`to_status`	`string`

curl https://work.nightroll.app/api/v1/issues.transition_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.transitionsread

REST POST /api/v1/issues.transitions · MCP tool issues_transitions · scopes issues:read

Input

keyrequired string

Output `object[]`

`allowed`	`boolean`	False when a condition blocks the caller (see `reason`).
`id`	`integer`	Transition id; null in an open workflow.
`name`	`string`
`needs_approval`	`boolean`	Moving needs approval first (`approvals.request`).
`reason`	`string`
`require`	`string[]`	Fields the transition requires.
`to_status`	`string`

curl https://work.nightroll.app/api/v1/issues.transitions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.triageread

REST POST /api/v1/issues.triage · MCP tool issues_triage · scopes issues:read

Input

`description`	`string`
`key`	`string`
`model`	`string`
`project`required	`string`
`provider`	`string`
`title`required	`string`

Output `object`

`assignee`	`string`	A member id seen working on this project or on similar issues.
`duplicates`	`object[]`
`kind`	`string`	Keys of the org's options; null when the model had no confident pick (or picked something that doesn't exist).
`labels`	`string[]`
`priority`	`string`
`why`	`string`	One sentence on why.

curl https://work.nightroll.app/api/v1/issues.triage \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>","title":"<title>"}'

issues.triage_parseread

REST POST /api/v1/issues.triage_parse · MCP tool issues_triage_parse · scopes issues:read

Input

`key`	`string`
`project`required	`string`
`text`required	`string`	The model's answer.
`title`	`string`

Output `object`

`assignee`	`string`	A member id seen working on this project or on similar issues.
`duplicates`	`object[]`
`kind`	`string`	Keys of the org's options; null when the model had no confident pick (or picked something that doesn't exist).
`labels`	`string[]`
`priority`	`string`
`why`	`string`	One sentence on why.

curl https://work.nightroll.app/api/v1/issues.triage_parse \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>","text":"<text>"}'

issues.triage_promptread

REST POST /api/v1/issues.triage_prompt · MCP tool issues_triage_prompt · scopes issues:read

Input

`description`	`string`
`key`	`string`	Triaging an existing issue (the queue): its key.
`project`required	`string`
`title`required	`string`

Output `object`

`prompt`	`string`
`subjects`	`string[]`	What the prompt contains (for AI exclusions).
`system`	`string`

curl https://work.nightroll.app/api/v1/issues.triage_prompt \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>","title":"<title>"}'

issues.unlinkwrite

REST POST /api/v1/issues.unlink · MCP tool issues_unlink · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.unlink \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.updatewrite

REST POST /api/v1/issues.update · MCP tool issues_update · scopes issues:write

Input

`add_labels`	`string[]`	Labels to add (after `labels`).
`affects_versions`	`string[]`
`base`	`object`	The values you saw for the fields you're changing (same names as the issue's; custom fields under `fields`). Where someone else changed one since, your value still wins and the answer's `notices` say who and what.
`components`	`string[]`	Replace the issue's components / versions (names).
`description`	`string`	Markdown. Sent without `description_doc`, it replaces the rich document too.
`description_doc`	`string`	The description as a rich document (TipTap JSON); send `description` (its markdown) with it. null clears it.
`due_date`	`string`	YYYY-MM-DD; null clears.
`expect_status`	`string`	Compare-and-set: fail with 409 if the issue is no longer in this status.
`fields`	`object`	Custom field values to set (null clears); fields left out are unchanged.
`fix_versions`	`string[]`
`key`required	`string`
`kind`	`string`
`labels`	`string[]`	Replaces the issue's labels.
`parent`	`string`	Parent key; null clears.
`points`	`number`	null clears.
`priority`	`string`
`remove_labels`	`string[]`	Labels to remove (after `labels`).
`resolution`	`string`	Resolution key when landing in (or already in) a done lane; defaults to the transition's, else the first.
`security`	`integer`	Security level id; null = visible to the whole project.
`start_date`	`string`	YYYY-MM-DD; null clears.
`status`	`string`	Target lane. If the project has a workflow, a transition to it must exist and be allowed.
`title`	`string`

Output `object`

`affects_versions`	`string[]`
`assignee`	`string`
`category`	`string`	The lane's category: todo \| in_progress \| done.
`children`	`integer`	Children (issues whose parent this is).
`components`	`string[]`
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`description_doc`	`string`	The description as a rich document (TipTap JSON); null when there's only the markdown `description`.
`due_date`	`string`	YYYY-MM-DD
`epic`	`string`	Key of the epic (level-1 ancestor: the parent, or a sub-task's grandparent).
`fields`	`object`	Custom field values by key, formulas computed.
`fix_versions`	`string[]`
`id`	`integer`	Internal id; comments use the subject `issue:{id}`.
`key`	`string`	`{project}-{number}`, e.g. "KB-12".
`kind`	`string`
`labels`	`string[]`	Label keys.
`notices`	`object[]`	Only on `issues.update` / `issues.assign` answers: fields someone else changed since `base` that yours replaced.
`number`	`integer`
`parent`	`string`	Key of the parent issue (one hierarchy level up).
`points`	`number`	Story points.
`priority`	`string`
`project`	`string`
`rank`	`string`	Backlog order within the project: sort by this text, ascending (see `issues.rank`). Null until the backfill runs.
`recurring`	`string`	day \| week \| month when this issue is a recurring template.
`resolution`	`string`	Resolution key; set while in a done lane.
`resolved_at`	`integer`
`security`	`integer`	Security level id: only its members (plus the reporter, assignee and admins) see the issue. Null = the project's viewers.
`sprint`	`integer`	Sprint id; null = backlog.
`start_date`	`string`	YYYY-MM-DD
`status`	`string`	Lane key within the project.
`title`	`string`
`updated_at`	`integer`
`votes`	`integer`
`watchers`	`integer`

curl https://work.nightroll.app/api/v1/issues.update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

issues.version_deletedestructive

REST POST /api/v1/issues.version_delete · MCP tool issues_version_delete · scopes issues:write

Input

`id`required	`integer`
`move_to`	`integer`	Issues move to this version instead of losing it.

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/issues.version_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

issues.version_releasewrite

REST POST /api/v1/issues.version_release · MCP tool issues_version_release · scopes issues:write

Input

`id`required	`integer`
`move_to`	`integer`	Unfinished issues move to this version of the same project; omit to leave them.
`released`required	`boolean`	false un-releases.

Output `object`

`description`	`string`
`done`	`integer`
`id`	`integer`
`issues`	`integer`	Issues with this fix version, and how many of them are done.
`name`	`string`
`notes`	`string`	Saved release notes (markdown).
`project`	`string`
`release_date`	`string`
`released`	`boolean`
`released_at`	`integer`
`start_date`	`string`	YYYY-MM-DD

curl https://work.nightroll.app/api/v1/issues.version_release \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"released":true}'

issues.version_savewrite

REST POST /api/v1/issues.version_save · MCP tool issues_version_save · scopes issues:write

Input

`description`	`string`
`id`	`integer`
`name`	`string`
`project`	`string`
`release_date`	`string`
`start_date`	`string`	YYYY-MM-DD; "" clears.

Output `object`

`description`	`string`
`done`	`integer`
`id`	`integer`
`issues`	`integer`	Issues with this fix version, and how many of them are done.
`name`	`string`
`notes`	`string`	Saved release notes (markdown).
`project`	`string`
`release_date`	`string`
`released`	`boolean`
`released_at`	`integer`
`start_date`	`string`	YYYY-MM-DD

curl https://work.nightroll.app/api/v1/issues.version_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

issues.versionsread

REST POST /api/v1/issues.versions · MCP tool issues_versions · scopes issues:read

Input

projectrequired string

Output `object[]`

`description`	`string`
`done`	`integer`
`id`	`integer`
`issues`	`integer`	Issues with this fix version, and how many of them are done.
`name`	`string`
`notes`	`string`	Saved release notes (markdown).
`project`	`string`
`release_date`	`string`
`released`	`boolean`
`released_at`	`integer`
`start_date`	`string`	YYYY-MM-DD

curl https://work.nightroll.app/api/v1/issues.versions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.votewrite

REST POST /api/v1/issues.vote · MCP tool issues_vote · scopes issues:write

Input

`key`required	`string`
`voted`required	`boolean`

Output `object`

`voted`	`boolean`
`votes`	`integer`
`watchers`	`string[]`	Watcher ids.
`watching`	`boolean`

curl https://work.nightroll.app/api/v1/issues.vote \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","voted":true}'

issues.watchwrite

REST POST /api/v1/issues.watch · MCP tool issues_watch · scopes issues:write

Input

`key`required	`string`
`watching`required	`boolean`
`who`	`string`	Someone else to add or remove (admins and the issue's assignee/reporter); default the caller.

Output `object`

`voted`	`boolean`
`votes`	`integer`
`watchers`	`string[]`	Watcher ids.
`watching`	`boolean`

curl https://work.nightroll.app/api/v1/issues.watch \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","watching":true}'

issues.workflowread

REST POST /api/v1/issues.workflow · MCP tool issues_workflow · scopes issues:read

Input

projectrequired string

Output `object[]`

`from_status`	`string`	null = from any status.
`id`	`integer`
`name`	`string`
`position`	`number`
`project`	`string`
`rules`	`object`
`to_status`	`string`

curl https://work.nightroll.app/api/v1/issues.workflow \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

issues.workflow_copywrite

REST POST /api/v1/issues.workflow_copy · MCP tool issues_workflow_copy · scopes issues:write

Input

`from`required	`string`
`to`required	`string`

Output `object[]`

`from_status`	`string`	null = from any status.
`id`	`integer`
`name`	`string`
`position`	`number`
`project`	`string`
`rules`	`object`
`to_status`	`string`

curl https://work.nightroll.app/api/v1/issues.workflow_copy \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"from":"<from>","to":"<to>"}'

jobs

jobs.listwrite

REST POST /api/v1/jobs.list · MCP tool jobs_list · scopes admin

Input

`limit`	`integer`	1-200, default 50.
`state`	`string`	queued \| running \| done \| dead; all when omitted.

Output `object`

`jobs`	`object[]`
`schedules`	`object[]`

curl https://work.nightroll.app/api/v1/jobs.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

jobs.retrywrite

REST POST /api/v1/jobs.retry · MCP tool jobs_retry · scopes admin

Input

idrequired integer

Output `object`

`attempts`	`integer`
`created_at`	`integer`
`finished_at`	`integer`
`id`	`integer`
`kind`	`string`	`<module>.<what>`, e.g. `webhooks.deliver`.
`last_error`	`string`
`max_attempts`	`integer`
`payload`	`any`
`run_at`	`integer`
`state`	`string`	queued \| running \| done \| dead.

curl https://work.nightroll.app/api/v1/jobs.retry \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

keys

keys.createwrite

REST POST /api/v1/keys.create · MCP tool keys_create · scopes keys:write

Input

`cidrs`	`string[]`	Only accept it from these addresses or CIDR ranges.
`expires_days`	`integer`	Days until it expires (1–365, default 90).
`kind`required	`string`	personal \| agent
`name`required	`string`
`scopes`required	`string[]`	Scopes like `issues:read`, `issues:write`, `pages:read`; `read` = every module's read scope, `write` = every module's read and write. A key never gets more than its owner's role allows.

Output `object`

`key`	`object`
`secret`	`string`	The key itself. Shown once: store it now.

curl https://work.nightroll.app/api/v1/keys.create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"kind":"<kind>","name":"<name>","scopes":[]}'

keys.listread

REST POST /api/v1/keys.list · MCP tool keys_list · scopes keys:read

Input

None: send {}.

Output `object[]`

`cidrs`	`string[]`
`created_at`	`integer`
`expires_at`	`integer`
`id`	`integer`
`kind`	`string`	personal (acts as you) \| agent (acts on your behalf as `agent:<name>`)
`last_ip`	`string`
`last_used_at`	`integer`
`name`	`string`
`owner`	`string`
`prefix`	`string`	First characters of the key, to recognize it.
`revoked_at`	`integer`
`scopes`	`string[]`

curl https://work.nightroll.app/api/v1/keys.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

keys.revokedestructive

REST POST /api/v1/keys.revoke · MCP tool keys_revoke · scopes keys:write

Input

idrequired integer

Output `object`

`cidrs`	`string[]`
`created_at`	`integer`
`expires_at`	`integer`
`id`	`integer`
`kind`	`string`	personal (acts as you) \| agent (acts on your behalf as `agent:<name>`)
`last_ip`	`string`
`last_used_at`	`integer`
`name`	`string`
`owner`	`string`
`prefix`	`string`	First characters of the key, to recognize it.
`revoked_at`	`integer`
`scopes`	`string[]`

curl https://work.nightroll.app/api/v1/keys.revoke \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

links

links.refreshwrite

REST POST /api/v1/links.refresh · MCP tool links_refresh · scopes links:write

Input

urlrequired string

Output `object`

`code`	`string`	Code permalinks (W607): the linked lines, the first line's number and the language (from the file extension).
`code_start`	`integer`
`description`	`string`
`embed`	`string`	Design files (Figma, Miro): a URL to show in an iframe.
`error`	`string`
`fetched_at`	`integer`
`host`	`string`
`id`	`integer`
`image`	`string`	An absolute image URL (og:image), or empty.
`lang`	`string`
`provider`	`string`	Known service from the host (GitHub, Figma, Google Docs …), else the host.
`site`	`string`	The site's own name (og:site_name), or empty.
`state`	`string`	pending (being fetched) \| ok \| error (the page couldn't be read: private, blocked, gone)
`title`	`string`
`url`	`string`

curl https://work.nightroll.app/api/v1/links.refresh \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"url":"<url>"}'

links.unfurlread

REST POST /api/v1/links.unfurl · MCP tool links_unfurl · scopes links:read

Input

urlrequired string

Output `object`

`code`	`string`	Code permalinks (W607): the linked lines, the first line's number and the language (from the file extension).
`code_start`	`integer`
`description`	`string`
`embed`	`string`	Design files (Figma, Miro): a URL to show in an iframe.
`error`	`string`
`fetched_at`	`integer`
`host`	`string`
`id`	`integer`
`image`	`string`	An absolute image URL (og:image), or empty.
`lang`	`string`
`provider`	`string`	Known service from the host (GitHub, Figma, Google Docs …), else the host.
`site`	`string`	The site's own name (og:site_name), or empty.
`state`	`string`	pending (being fetched) \| ok \| error (the page couldn't be read: private, blocked, gone)
`title`	`string`
`url`	`string`

curl https://work.nightroll.app/api/v1/links.unfurl \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"url":"<url>"}'

links.unfurl_resultwrite

REST POST /api/v1/links.unfurl_result · MCP tool links_unfurl_result · scopes system

Input

`code`	`string`
`code_start`	`integer`
`description`	`string`
`error`	`string`
`image`	`string`
`ok`required	`boolean`
`site`	`string`
`title`	`string`
`url`required	`string`

Output `object`

`code`	`string`	Code permalinks (W607): the linked lines, the first line's number and the language (from the file extension).
`code_start`	`integer`
`description`	`string`
`embed`	`string`	Design files (Figma, Miro): a URL to show in an iframe.
`error`	`string`
`fetched_at`	`integer`
`host`	`string`
`id`	`integer`
`image`	`string`	An absolute image URL (og:image), or empty.
`lang`	`string`
`provider`	`string`	Known service from the host (GitHub, Figma, Google Docs …), else the host.
`site`	`string`	The site's own name (og:site_name), or empty.
`state`	`string`	pending (being fetched) \| ok \| error (the page couldn't be read: private, blocked, gone)
`title`	`string`
`url`	`string`

curl https://work.nightroll.app/api/v1/links.unfurl_result \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"ok":true,"url":"<url>"}'

market

market.bundlewrite

REST POST /api/v1/market.bundle · MCP tool market_bundle · scopes admin

Input

idrequired integer

Output `any`

curl https://work.nightroll.app/api/v1/market.bundle \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

market.listingread

REST POST /api/v1/market.listing · MCP tool market_listing · scopes market:read

Input

idrequired integer

Output `object`

`bundle`	`string`	The signed bundle, to install (`plugins.install {signed: {bundle, publisher, signature, listing}}`).
`latest`	`object`	The latest approved version.
`signature`	`string`

curl https://work.nightroll.app/api/v1/market.listing \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

market.listingsread

REST POST /api/v1/market.listings · MCP tool market_listings · scopes market:read

Input

q string Words in the name or summary.

Output `object[]`

`allow`	`string[]`
`id`	`integer`
`listing`	`integer`
`name`	`string`
`note`	`string`
`permissions`	`string[]`
`plugin`	`string`
`publisher_key`	`string`
`publisher_org`	`string`
`reviewed_at`	`integer`
`runtime`	`string`	rhai \| wasm
`sha256`	`string`
`state`	`string`	submitted \| approved \| rejected
`submitted_at`	`integer`
`summary`	`string`
`version`	`string`

curl https://work.nightroll.app/api/v1/market.listings \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

market.reviewwrite

REST POST /api/v1/market.review · MCP tool market_review · scopes admin

Input

`approve`required	`boolean`
`id`required	`integer`	The version id.
`note`	`string`	Why (shown to the publisher).

Output `object`

`allow`	`string[]`
`id`	`integer`
`listing`	`integer`
`name`	`string`
`note`	`string`
`permissions`	`string[]`
`plugin`	`string`
`publisher_key`	`string`
`publisher_org`	`string`
`reviewed_at`	`integer`
`runtime`	`string`	rhai \| wasm
`sha256`	`string`
`state`	`string`	submitted \| approved \| rejected
`submitted_at`	`integer`
`summary`	`string`
`version`	`string`

curl https://work.nightroll.app/api/v1/market.review \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"approve":true,"id":1}'

market.submissionsread

REST POST /api/v1/market.submissions · MCP tool market_submissions · scopes market:read

Input

None: send {}.

Output `object`

`reviewer`	`boolean`	The caller reviews the catalog (an admin of the org that keeps it).
`versions`	`object[]`

curl https://work.nightroll.app/api/v1/market.submissions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

market.submitwrite

REST POST /api/v1/market.submit · MCP tool market_submit · scopes market:write

Input

`bundle`required	`string`	The bundle text from `plugins.sign`.
`publisher`required	`string`
`signature`required	`string`

Output `object`

`allow`	`string[]`
`id`	`integer`
`listing`	`integer`
`name`	`string`
`note`	`string`
`permissions`	`string[]`
`plugin`	`string`
`publisher_key`	`string`
`publisher_org`	`string`
`reviewed_at`	`integer`
`runtime`	`string`	rhai \| wasm
`sha256`	`string`
`state`	`string`	submitted \| approved \| rejected
`submitted_at`	`integer`
`summary`	`string`
`version`	`string`

curl https://work.nightroll.app/api/v1/market.submit \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"bundle":"<bundle>","publisher":"<publisher>","signature":"<signature>"}'

notifications

notifications.digestread

REST POST /api/v1/notifications.digest · MCP tool notifications_digest · scopes notifications:read

Input

None: send {}.

Output `object`

`empty`	`boolean`	Nothing to report (no open work, no mentions).
`focus`	`any`	The ranked focus list (`issues.focus`); null when issues are switched off.
`mentions`	`object[]`	Unread mentions of you or your teams.
`period`	`string`	day \| week
`week`	`any`	Weekly: issues of yours done in the last 7 days, open ones due in the next 7, and overdue ones.

curl https://work.nightroll.app/api/v1/notifications.digest \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.digest_prefsread

REST POST /api/v1/notifications.digest_prefs · MCP tool notifications_digest_prefs · scopes notifications:read

Input

None: send {}.

Output `object`

`ai`	`boolean`	Add a short AI-written plan for the day (needs a usable AI model; org key for email).
`at`	`string`	HH:MM in the person's own time.
`browser`	`boolean`	Show a browser notification the first time the app is open after `at`.
`email`	`boolean`	Send it by email each morning.
`period`	`string`	day \| week
`tz_offset`	`integer`	Minutes behind UTC, as the browser's `Date.getTimezoneOffset()` gives it.
`week_day`	`integer`	Weekly: the day it comes, 0 = Sunday … 6 = Saturday.
`weekdays`	`boolean`	Weekdays only (Monday to Friday, local time).

curl https://work.nightroll.app/api/v1/notifications.digest_prefs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.digest_prefs_setwrite

REST POST /api/v1/notifications.digest_prefs_set · MCP tool notifications_digest_prefs_set · scopes notifications:write

Input

`ai`required	`boolean`	Add a short AI-written plan for the day (needs a usable AI model; org key for email).
`at`required	`string`	HH:MM in the person's own time.
`browser`required	`boolean`	Show a browser notification the first time the app is open after `at`.
`email`required	`boolean`	Send it by email each morning.
`period`	`string`	day \| week
`tz_offset`required	`integer`	Minutes behind UTC, as the browser's `Date.getTimezoneOffset()` gives it.
`week_day`	`integer`	Weekly: the day it comes, 0 = Sunday … 6 = Saturday.
`weekdays`required	`boolean`	Weekdays only (Monday to Friday, local time).

Output `object`

`ai`	`boolean`	Add a short AI-written plan for the day (needs a usable AI model; org key for email).
`at`	`string`	HH:MM in the person's own time.
`browser`	`boolean`	Show a browser notification the first time the app is open after `at`.
`email`	`boolean`	Send it by email each morning.
`period`	`string`	day \| week
`tz_offset`	`integer`	Minutes behind UTC, as the browser's `Date.getTimezoneOffset()` gives it.
`week_day`	`integer`	Weekly: the day it comes, 0 = Sunday … 6 = Saturday.
`weekdays`	`boolean`	Weekdays only (Monday to Friday, local time).

curl https://work.nightroll.app/api/v1/notifications.digest_prefs_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"ai":true,"at":"<at>","browser":true,"email":true,"tz_offset":1,"weekdays":true}'

notifications.email_memberwrite

REST POST /api/v1/notifications.email_member · MCP tool notifications_email_member · scopes system

Input

`identity`required	`string`
`notification`required	`any`

Output `object`

updated integer

curl https://work.nightroll.app/api/v1/notifications.email_member \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"identity":"<identity>","notification":"<notification>"}'

notifications.listread

REST POST /api/v1/notifications.list · MCP tool notifications_list · scopes notifications:read

Input

None: send {}.

Output `object[]`

`actor`	`string`
`created_at`	`integer`
`id`	`integer`	The event's seq; one notification per event.
`kind`	`string`	Event kind, e.g. "comment.created".
`read`	`boolean`
`reason`	`string`	"mentioned", "assigned".
`subject`	`string`	`kind:id`, e.g. "issue:12".
`team`	`integer`	Set when it reached the caller only through this team.
`title`	`string`	The subject's current title.

curl https://work.nightroll.app/api/v1/notifications.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.mark_readwrite

REST POST /api/v1/notifications.mark_read · MCP tool notifications_mark_read · scopes notifications:write

Input

id integer A notification id; omit to mark everything read.

Output `object`

updated integer

curl https://work.nightroll.app/api/v1/notifications.mark_read \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.policiesread

REST POST /api/v1/notifications.policies · MCP tool notifications_policies · scopes notifications:read

Input

None: send {}.

Output `object`

`limits`	`object`
`policies`	`object[]`

curl https://work.nightroll.app/api/v1/notifications.policies \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.policies_setwrite

REST POST /api/v1/notifications.policies_set · MCP tool notifications_policies_set · scopes admin

Input

`limits`	`object`
`policies`required	`object[]`

Output `object`

`limits`	`object`
`policies`	`object[]`

curl https://work.nightroll.app/api/v1/notifications.policies_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"policies":[]}'

notifications.prefsread

REST POST /api/v1/notifications.prefs · MCP tool notifications_prefs · scopes notifications:read

Input

None: send {}.

Output `object`

`channels`	`object[]`
`email_by_default`	`string[]`	Reasons that email by default (everything goes to the inbox by default).
`policies`	`object[]`	The org's policies (W807): locked ones override these rules, required ones can't be turned off.
`quiet`	`object`
`reasons`	`object[]`	Reasons rules can name, with what happens by default.
`rules`	`object[]`

curl https://work.nightroll.app/api/v1/notifications.prefs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.prefs_setwriteReplaces your rules and/or quiet hours in this organization.

REST POST /api/v1/notifications.prefs_set · MCP tool notifications_prefs_set · scopes notifications:write

Input

`quiet`	`object`
`rules`	`object[]`

Output `object`

`channels`	`object[]`
`email_by_default`	`string[]`	Reasons that email by default (everything goes to the inbox by default).
`policies`	`object[]`	The org's policies (W807): locked ones override these rules, required ones can't be turned off.
`quiet`	`object`
`reasons`	`object[]`	Reasons rules can name, with what happens by default.
`rules`	`object[]`

curl https://work.nightroll.app/api/v1/notifications.prefs_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.push_deliveredwrite

REST POST /api/v1/notifications.push_delivered · MCP tool notifications_push_delivered · scopes system

Input

`endpoint`required	`string`
`ok`required	`boolean`	false: the push service says the subscription is gone.

Output `object`

public string The application server key for `pushManager.subscribe` (base64url); null until the cell made one.

curl https://work.nightroll.app/api/v1/notifications.push_delivered \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"endpoint":"<endpoint>","ok":true}'

notifications.push_keyread

REST POST /api/v1/notifications.push_key · MCP tool notifications_push_key · scopes notifications:read

Input

None: send {}.

Output `object`

public string The application server key for `pushManager.subscribe` (base64url); null until the cell made one.

curl https://work.nightroll.app/api/v1/notifications.push_key \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.push_queuewrite

REST POST /api/v1/notifications.push_queue · MCP tool notifications_push_queue · scopes system

Input

None: send {}.

Output `object`

public string The application server key for `pushManager.subscribe` (base64url); null until the cell made one.

curl https://work.nightroll.app/api/v1/notifications.push_queue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.push_subscribewrite

REST POST /api/v1/notifications.push_subscribe · MCP tool notifications_push_subscribe · scopes notifications:write

Input

`auth`required	`string`
`endpoint`required	`string`
`label`	`string`	e.g. "Chrome on Mac".
`p256dh`required	`string`	`keys.p256dh` and `keys.auth` of the browser's subscription (base64url).

Output `object[]`

`created_at`	`integer`
`endpoint`	`string`
`label`	`string`
`last_ok_at`	`integer`

curl https://work.nightroll.app/api/v1/notifications.push_subscribe \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"auth":"<auth>","endpoint":"<endpoint>","p256dh":"<p256dh>"}'

notifications.push_subscriptionsread

REST POST /api/v1/notifications.push_subscriptions · MCP tool notifications_push_subscriptions · scopes notifications:read

Input

None: send {}.

Output `object[]`

`created_at`	`integer`
`endpoint`	`string`
`label`	`string`
`last_ok_at`	`integer`

curl https://work.nightroll.app/api/v1/notifications.push_subscriptions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.push_targetswrite

REST POST /api/v1/notifications.push_targets · MCP tool notifications_push_targets · scopes system

Input

identityrequired string

Output `object`

`private`	`string`
`public`	`string`
`subscriptions`	`any[][]`	(endpoint, p256dh, auth)

curl https://work.nightroll.app/api/v1/notifications.push_targets \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"identity":"<identity>"}'

notifications.push_testwrite

REST POST /api/v1/notifications.push_test · MCP tool notifications_push_test · scopes notifications:write

Input

None: send {}.

Output `object[]`

`created_at`	`integer`
`endpoint`	`string`
`label`	`string`
`last_ok_at`	`integer`

curl https://work.nightroll.app/api/v1/notifications.push_test \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

notifications.push_unsubscribewrite

REST POST /api/v1/notifications.push_unsubscribe · MCP tool notifications_push_unsubscribe · scopes notifications:write

Input

endpointrequired string

Output `object[]`

`created_at`	`integer`
`endpoint`	`string`
`label`	`string`
`last_ok_at`	`integer`

curl https://work.nightroll.app/api/v1/notifications.push_unsubscribe \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"endpoint":"<endpoint>"}'

notifications.vapid_setwrite

REST POST /api/v1/notifications.vapid_set · MCP tool notifications_vapid_set · scopes system

Input

`private`required	`string`
`public`required	`string`

Output `object`

public string The application server key for `pushManager.subscribe` (base64url); null until the cell made one.

curl https://work.nightroll.app/api/v1/notifications.vapid_set \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"private":"<private>","public":"<public>"}'

pages

pages.analyticsread

REST POST /api/v1/pages.analytics · MCP tool pages_analytics · scopes pages:read

Input

`days`	`integer`	Days back for the daily series (7-365, default 30).
`id`required	`string`

Output `object`

`people`	`object[]`	Who has seen the page, most recent first.
`readers`	`integer`
`series`	`object[]`	Every day of the window, oldest first.
`views`	`integer`	All-time views and distinct readers.

curl https://work.nightroll.app/api/v1/pages.analytics \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.attachment_addwrite

REST POST /api/v1/pages.attachment_add · MCP tool pages_attachment_add · scopes pages:write

Input

`data`required	`string`	Base64 bytes; at most 50 KB decoded.
`mime`required	`string`
`name`required	`string`
`page`required	`string`

Output `object`

`created_at`	`integer`
`created_by`	`string`
`id`	`string`
`mime`	`string`
`name`	`string`
`page`	`string`
`size`	`integer`

curl https://work.nightroll.app/api/v1/pages.attachment_add \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"data":"<data>","mime":"<mime>","name":"<name>","page":"<page>"}'

pages.attachment_deletedestructive

REST POST /api/v1/pages.attachment_delete · MCP tool pages_attachment_delete · scopes pages:write

Input

idrequired string

Output `object`

deleted integer

curl https://work.nightroll.app/api/v1/pages.attachment_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.attachment_getread

REST POST /api/v1/pages.attachment_get · MCP tool pages_attachment_get · scopes pages:read

Input

`as_url`	`boolean`	A download link instead of the bytes, where the deployment serves files from their own origin.
`id`required	`string`

Output `object`

`data`	`string`	Base64 bytes (empty when `url` is given).
`id`	`string`
`mime`	`string`
`name`	`string`
`url`	`string`	With `as_url`, where the deployment has a files origin: a five-minute link that downloads it.

curl https://work.nightroll.app/api/v1/pages.attachment_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.attachmentsread

REST POST /api/v1/pages.attachments · MCP tool pages_attachments · scopes pages:read

Input

idrequired string

Output `object[]`

`created_at`	`integer`
`created_by`	`string`
`id`	`string`
`mime`	`string`
`name`	`string`
`page`	`string`
`size`	`integer`

curl https://work.nightroll.app/api/v1/pages.attachments \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.blogread

REST POST /api/v1/pages.blog · MCP tool pages_blog · scopes pages:read

Input

`limit`	`integer`	Newest first; default 50, max 5000.
`space`	`string`	One space's blog; omitted = every space you can see.

Output `object[]`

`created_by`	`string`
`icon`	`string`
`id`	`string`
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (yours, unpublished) \| current
`summary`	`string`	The start of the post's text (markdown), for the blog list.
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/pages.blog \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

pages.boardread

REST POST /api/v1/pages.board · MCP tool pages_board · scopes pages:read

Input

idrequired string

Output `object`

`can_edit`	`boolean`
`state`	`string`	The yrs (Yjs) document as one update, base64; empty for a board nobody has drawn on.
`text`	`string`	Its notes' text, one per line.

curl https://work.nightroll.app/api/v1/pages.board \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.by_labelread

REST POST /api/v1/pages.by_label · MCP tool pages_by_label · scopes pages:read

Input

`label`required	`string`
`space`	`string`

Output `object[]`

`icon`	`string`
`id`	`string`
`labels`	`string[]`
`space`	`string`
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/pages.by_label \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"label":"<label>"}'

pages.createwrite

REST POST /api/v1/pages.create · MCP tool pages_create · scopes pages:write

Input

`doc_json`	`string`	Starting content (TipTap JSON) instead of a template.
`icon`	`string`
`kind`	`string`	page (default) \| blog: a blog post in the space's blog (no parent).
`parent`	`string`
`space`required	`string`
`template`	`integer`	Template id: the new draft starts with its content.
`title`	`string`	Defaults to "Untitled" (made unique). Titles are unique, so `[[Title]]` always means one page.

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"space":"<space>"}'

pages.db_column_deletedestructive

REST POST /api/v1/pages.db_column_delete · MCP tool pages_db_column_delete · scopes pages:write

Input

`db`required	`integer`
`id`required	`integer`

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_column_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"db":1,"id":1}'

pages.db_column_savewrite

REST POST /api/v1/pages.db_column_save · MCP tool pages_db_column_save · scopes pages:write

Input

`before`	`integer`	Put it before this column (omitted = keep its place, or last for a new one).
`db`required	`integer`
`id`	`integer`	Omitted = a new column.
`name`required	`string`
`options`	`object[]`
`type`required	`string`

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_column_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"db":1,"name":"<name>","type":"<type>"}'

pages.db_createwrite

REST POST /api/v1/pages.db_create · MCP tool pages_db_create · scopes pages:write

Input

`page`required	`string`
`title`	`string`

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"page":"<page>"}'

pages.db_deletedestructive

REST POST /api/v1/pages.db_delete · MCP tool pages_db_delete · scopes pages:write

Input

idrequired integer

Output `object`

deleted integer

curl https://work.nightroll.app/api/v1/pages.db_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

pages.db_getread

REST POST /api/v1/pages.db_get · MCP tool pages_db_get · scopes pages:read

Input

idrequired integer

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

pages.db_linksread

REST POST /api/v1/pages.db_links · MCP tool pages_db_links · scopes pages:read

Input

keyrequired string

Output `object[]`

`db`	`integer`
`label`	`string`	The row's first text cell, to name it.
`page`	`string`
`page_title`	`string`
`row`	`integer`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_links \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

pages.db_row_addwrite

REST POST /api/v1/pages.db_row_add · MCP tool pages_db_row_add · scopes pages:write

Input

`cells`	`object`
`db`required	`integer`

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_row_add \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"db":1}'

pages.db_row_deletedestructive

REST POST /api/v1/pages.db_row_delete · MCP tool pages_db_row_delete · scopes pages:write

Input

`db`required	`integer`
`row`required	`integer`

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_row_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"db":1,"row":1}'

pages.db_row_updatewrite

REST POST /api/v1/pages.db_row_update · MCP tool pages_db_row_update · scopes pages:write

Input

`cells`required	`object`	Column id → new value; null clears the cell. Other cells are kept.
`db`required	`integer`
`row`required	`integer`

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_row_update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"cells":"<cells>","db":1,"row":1}'

pages.db_updatewrite

REST POST /api/v1/pages.db_update · MCP tool pages_db_update · scopes pages:write

Input

`id`required	`integer`
`title`required	`string`

Output `object`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.db_update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"title":"<title>"}'

pages.dbsread

REST POST /api/v1/pages.dbs · MCP tool pages_dbs · scopes pages:read

Input

pagerequired string

Output `object[]`

`can_edit`	`boolean`
`columns`	`object[]`
`id`	`integer`
`page`	`string`
`rows`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/pages.dbs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"page":"<page>"}'

pages.deletedestructive

REST POST /api/v1/pages.delete · MCP tool pages_delete · scopes pages:write

Input

idrequired string

Output `object`

deleted integer

curl https://work.nightroll.app/api/v1/pages.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.discarddestructive

REST POST /api/v1/pages.discard · MCP tool pages_discard · scopes pages:write

Input

idrequired string

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.discard \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.exportread

REST POST /api/v1/pages.export · MCP tool pages_export · scopes pages:read

Input

`format`required	`string`	markdown \| html \| word
`id`required	`string`

Output `object`

`data`	`string`	The file's text (Markdown or HTML).
`mime`	`string`
`name`	`string`	A file name for the download.

curl https://work.nightroll.app/api/v1/pages.export \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"format":"<format>","id":"<id>"}'

pages.followread

REST POST /api/v1/pages.follow · MCP tool pages_follow · scopes pages:read

Input

`follow`required	`boolean`	true to follow, false to stop.
`key`required	`string`

Output `object`

`followers`	`integer`
`following`	`boolean`
`key`	`string`

curl https://work.nightroll.app/api/v1/pages.follow \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"follow":true,"key":"<key>"}'

pages.getread

REST POST /api/v1/pages.get · MCP tool pages_get · scopes pages:read

Input

idrequired string

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.includeread

REST POST /api/v1/pages.include · MCP tool pages_include · scopes pages:read

Input

`excerpt`	`boolean`	Only its excerpt (the first Excerpt block) rather than the whole page.
`id`required	`string`	The page to include.

Output `object`

`doc_json`	`string`	The published content (or the excerpt's) as TipTap JSON; empty when the page was never published.
`icon`	`string`
`id`	`string`
`no_excerpt`	`boolean`	excerpt was asked for but the page has no Excerpt block.
`space`	`string`
`text`	`string`	The same as markdown (excerpts: plain text).
`title`	`string`
`version`	`integer`

curl https://work.nightroll.app/api/v1/pages.include \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.labelsread

REST POST /api/v1/pages.labels · MCP tool pages_labels · scopes pages:read

Input

space string Only labels used in this space.

Output `object[]`

`label`	`string`
`pages`	`integer`

curl https://work.nightroll.app/api/v1/pages.labels \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

pages.listread

REST POST /api/v1/pages.list · MCP tool pages_list · scopes pages:read

Input

space string

Output `object[]`

`created_by`	`string`
`has_changes`	`boolean`
`icon`	`string`
`id`	`string`
`kind`	`string`	page \| whiteboard (blog posts aren't in the tree)
`parent`	`string`
`position`	`number`
`restricted`	`boolean`	Has its own view or edit restrictions.
`space`	`string`
`status`	`string`
`title`	`string`
`updated_at`	`integer`
`version`	`integer`

curl https://work.nightroll.app/api/v1/pages.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

pages.live_checkwrite

REST POST /api/v1/pages.live_check · MCP tool pages_live_check · scopes pages:write

Input

idrequired string

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/pages.live_check \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.movewrite

REST POST /api/v1/pages.move · MCP tool pages_move · scopes pages:write

Input

`before`	`string`	Put it right before this sibling; omit to put it last.
`id`required	`string`
`parent`	`string`	New parent page id; null or "" = top level of the (new) space.
`space`	`string`	Move to another space (with its sub-pages). Defaults to the parent's space.

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.move \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.permissionsread

REST POST /api/v1/pages.permissions · MCP tool pages_permissions · scopes pages:read

Input

idrequired string

Output `object`

`can_edit`	`boolean`
`editors`	`string[]`
`inherited_editors`	`string[]`
`inherited_viewers`	`string[]`	What applies when the page's own list is unset (nearest restricted parent, else the space).
`owner`	`string`
`viewers`	`string[]`	The page's own lists; null = inherited.

curl https://work.nightroll.app/api/v1/pages.permissions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.properties_reportread

REST POST /api/v1/pages.properties_report · MCP tool pages_properties_report · scopes pages:read

Input

`columns`	`string[]`	Only these columns, in this order (default: every key, in first-seen order).
`descending`	`boolean`
`label`	`string`	Pages with this label…
`sort`	`string`	Sort by this column (default: title).
`space`	`string`	…and/or in this space.

Output `object`

`columns`	`string[]`
`rows`	`object[]`

curl https://work.nightroll.app/api/v1/pages.properties_report \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

pages.publishwrite

REST POST /api/v1/pages.publish · MCP tool pages_publish · scopes pages:write

Input

`doc_json`required	`string`	The document to publish (TipTap JSON), as the editor has it.
`id`required	`string`
`message`	`string`	Optional note shown in the page history.
`text`required	`string`	The same content as markdown.
`title`	`string`

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.publish \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"doc_json":"<doc_json>","id":"<id>","text":"<text>"}'

pages.restorewrite

REST POST /api/v1/pages.restore · MCP tool pages_restore · scopes pages:write

Input

`id`required	`string`
`version`required	`integer`

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.restore \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>","version":1}'

pages.set_labelswrite

REST POST /api/v1/pages.set_labels · MCP tool pages_set_labels · scopes pages:write

Input

`id`required	`string`
`labels`required	`string[]`	Replaces the page's labels (cleaned: lowercase, dashes for spaces).

Output `string[]`

curl https://work.nightroll.app/api/v1/pages.set_labels \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>","labels":[]}'

pages.set_permissionswrite

REST POST /api/v1/pages.set_permissions · MCP tool pages_set_permissions · scopes pages:write

Input

`editors`	`string[]`
`id`required	`string`
`viewers`	`string[]`	`everyone`, `admins`, `team:<id>` or member ids; null = inherit; omit to leave unchanged.

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.set_permissions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.space_analyticsread

REST POST /api/v1/pages.space_analytics · MCP tool pages_space_analytics · scopes pages:read

Input

`days`	`integer`
`key`required	`string`

Output `object`

`pages`	`object[]`	Most viewed pages in the window (pages you can see), top 20.
`readers`	`integer`
`series`	`object[]`
`views`	`integer`

curl https://work.nightroll.app/api/v1/pages.space_analytics \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

pages.space_createwrite

REST POST /api/v1/pages.space_create · MCP tool pages_space_create · scopes pages:write

Input

`color`	`string`
`description`	`string`
`icon`	`string`
`key`required	`string`	2-10 letters/digits, starting with a letter (like project keys).
`name`required	`string`

Output `object`

`can_edit`	`boolean`	What the caller may do.
`can_manage`	`boolean`
`color`	`string`
`created_at`	`integer`
`created_by`	`string`	The owner: may change permissions and delete the space (as may admins).
`description`	`string`
`editors`	`string[]`	Who may add and edit its pages (pages can narrow this).
`followers`	`integer`
`following`	`boolean`	The caller follows the space (new blog posts notify them).
`home`	`string`	The space's home page id.
`icon`	`string`
`key`	`string`
`name`	`string`
`pages`	`integer`	Published pages in the space.
`viewers`	`string[]`	Who sees the space: `everyone`, `admins`, `team:<id>` or member ids.

curl https://work.nightroll.app/api/v1/pages.space_create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","name":"<name>"}'

pages.space_deletedestructive

REST POST /api/v1/pages.space_delete · MCP tool pages_space_delete · scopes pages:write

Input

keyrequired string

Output `object`

deleted integer

curl https://work.nightroll.app/api/v1/pages.space_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

pages.space_exportwrite

REST POST /api/v1/pages.space_export · MCP tool pages_space_export · scopes pages:write

Input

`format`required	`string`	markdown \| html
`key`required	`string`

Output `object`

`created_at`	`integer`
`error`	`string`
`finished_at`	`integer`
`format`	`string`
`id`	`integer`
`pages`	`integer`
`requested_by`	`string`
`size`	`integer`
`space`	`string`
`state`	`string`	queued \| ready \| failed

curl https://work.nightroll.app/api/v1/pages.space_export \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"format":"<format>","key":"<key>"}'

pages.space_export_getread

REST POST /api/v1/pages.space_export_get · MCP tool pages_space_export_get · scopes pages:read

Input

`as_url`	`boolean`	A download link instead of the bytes, where the deployment serves files from their own origin.
`id`required	`integer`

Output `object`

`data`	`string`	The .tar, base64 (empty when `url` is given).
`name`	`string`
`url`	`string`	With `as_url`, where the deployment has a files origin: a five-minute link that downloads it.

curl https://work.nightroll.app/api/v1/pages.space_export_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

pages.space_exportsread

REST POST /api/v1/pages.space_exports · MCP tool pages_space_exports · scopes pages:read

Input

keyrequired string

Output `object[]`

`created_at`	`integer`
`error`	`string`
`finished_at`	`integer`
`format`	`string`
`id`	`integer`
`pages`	`integer`
`requested_by`	`string`
`size`	`integer`
`space`	`string`
`state`	`string`	queued \| ready \| failed

curl https://work.nightroll.app/api/v1/pages.space_exports \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

pages.space_getread

REST POST /api/v1/pages.space_get · MCP tool pages_space_get · scopes pages:read

Input

keyrequired string

Output `object`

`can_edit`	`boolean`	What the caller may do.
`can_manage`	`boolean`
`color`	`string`
`created_at`	`integer`
`created_by`	`string`	The owner: may change permissions and delete the space (as may admins).
`description`	`string`
`editors`	`string[]`	Who may add and edit its pages (pages can narrow this).
`followers`	`integer`
`following`	`boolean`	The caller follows the space (new blog posts notify them).
`home`	`string`	The space's home page id.
`icon`	`string`
`key`	`string`
`name`	`string`
`pages`	`integer`	Published pages in the space.
`viewers`	`string[]`	Who sees the space: `everyone`, `admins`, `team:<id>` or member ids.

curl https://work.nightroll.app/api/v1/pages.space_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

pages.space_permissionswrite

REST POST /api/v1/pages.space_permissions · MCP tool pages_space_permissions · scopes pages:write

Input

`editors`	`string[]`
`key`required	`string`
`viewers`	`string[]`

Output `object`

`can_edit`	`boolean`	What the caller may do.
`can_manage`	`boolean`
`color`	`string`
`created_at`	`integer`
`created_by`	`string`	The owner: may change permissions and delete the space (as may admins).
`description`	`string`
`editors`	`string[]`	Who may add and edit its pages (pages can narrow this).
`followers`	`integer`
`following`	`boolean`	The caller follows the space (new blog posts notify them).
`home`	`string`	The space's home page id.
`icon`	`string`
`key`	`string`
`name`	`string`
`pages`	`integer`	Published pages in the space.
`viewers`	`string[]`	Who sees the space: `everyone`, `admins`, `team:<id>` or member ids.

curl https://work.nightroll.app/api/v1/pages.space_permissions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

pages.space_updatewrite

REST POST /api/v1/pages.space_update · MCP tool pages_space_update · scopes pages:write

Input

`color`	`string`
`description`	`string`
`home`	`string`	A page id in this space.
`icon`	`string`
`key`required	`string`
`name`	`string`

Output `object`

`can_edit`	`boolean`	What the caller may do.
`can_manage`	`boolean`
`color`	`string`
`created_at`	`integer`
`created_by`	`string`	The owner: may change permissions and delete the space (as may admins).
`description`	`string`
`editors`	`string[]`	Who may add and edit its pages (pages can narrow this).
`followers`	`integer`
`following`	`boolean`	The caller follows the space (new blog posts notify them).
`home`	`string`	The space's home page id.
`icon`	`string`
`key`	`string`
`name`	`string`
`pages`	`integer`	Published pages in the space.
`viewers`	`string[]`	Who sees the space: `everyone`, `admins`, `team:<id>` or member ids.

curl https://work.nightroll.app/api/v1/pages.space_update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

pages.spacesread

REST POST /api/v1/pages.spaces · MCP tool pages_spaces · scopes pages:read

Input

None: send {}.

Output `object[]`

`can_edit`	`boolean`	What the caller may do.
`can_manage`	`boolean`
`color`	`string`
`created_at`	`integer`
`created_by`	`string`	The owner: may change permissions and delete the space (as may admins).
`description`	`string`
`editors`	`string[]`	Who may add and edit its pages (pages can narrow this).
`followers`	`integer`
`following`	`boolean`	The caller follows the space (new blog posts notify them).
`home`	`string`	The space's home page id.
`icon`	`string`
`key`	`string`
`name`	`string`
`pages`	`integer`	Published pages in the space.
`viewers`	`string[]`	Who sees the space: `everyone`, `admins`, `team:<id>` or member ids.

curl https://work.nightroll.app/api/v1/pages.spaces \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

pages.template_deletedestructive

REST POST /api/v1/pages.template_delete · MCP tool pages_template_delete · scopes pages:write

Input

idrequired integer

Output `object`

deleted integer

curl https://work.nightroll.app/api/v1/pages.template_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

pages.template_savewrite

REST POST /api/v1/pages.template_save · MCP tool pages_template_save · scopes pages:write

Input

`description`	`string`
`doc_json`required	`string`
`icon`	`string`
`id`	`integer`
`name`required	`string`
`space`	`string`

Output `object`

`created_by`	`string`
`description`	`string`
`doc_json`	`string`
`icon`	`string`
`id`	`integer`
`name`	`string`
`space`	`string`	Space it belongs to; null = every space.

curl https://work.nightroll.app/api/v1/pages.template_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"doc_json":"<doc_json>","name":"<name>"}'

pages.templatesread

REST POST /api/v1/pages.templates · MCP tool pages_templates · scopes pages:read

Input

None: send {}.

Output `object[]`

`created_by`	`string`
`description`	`string`
`doc_json`	`string`
`icon`	`string`
`id`	`integer`
`name`	`string`
`space`	`string`	Space it belongs to; null = every space.

curl https://work.nightroll.app/api/v1/pages.templates \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

pages.updatewrite

REST POST /api/v1/pages.update · MCP tool pages_update · scopes pages:write

Input

`icon`	`string`
`id`required	`string`
`title`	`string`

Output `object`

`can_edit`	`boolean`	Whether the caller may edit (and so change permissions or delete).
`created_at`	`integer`
`created_by`	`string`
`doc_json`	`string`	Published content as ProseMirror/TipTap JSON. Empty with version ≥ 1 means legacy markdown in `text`.
`editors`	`string[]`
`has_changes`	`boolean`	The live (being edited) doc differs from the published version.
`icon`	`string`
`id`	`string`
`kind`	`string`	page (in the space's tree) \| blog (a dated post in the space's blog)
`labels`	`string[]`	Labels (lowercase tags).
`parent`	`string`	Parent page id; null = top level of the space.
`published_at`	`integer`	When it was first published; null for drafts.
`space`	`string`
`status`	`string`	draft (only its author sees it, never published) \| current
`text`	`string`	Published content as markdown: search, mentions, smart-link embeds and agents read this.
`title`	`string`
`updated_at`	`integer`
`updated_by`	`string`
`version`	`integer`	Published version number; 0 = never published.
`viewers`	`string[]`	The page's own restrictions; null = inherited from its parent pages and the space.

curl https://work.nightroll.app/api/v1/pages.update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.version_getread

REST POST /api/v1/pages.version_get · MCP tool pages_version_get · scopes pages:read

Input

`id`required	`string`
`version`required	`integer`

Output `object`

`author`	`string`
`created_at`	`integer`
`doc_json`	`string`
`message`	`string`
`text`	`string`
`title`	`string`
`version`	`integer`

curl https://work.nightroll.app/api/v1/pages.version_get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>","version":1}'

pages.versionsread

REST POST /api/v1/pages.versions · MCP tool pages_versions · scopes pages:read

Input

idrequired string

Output `object[]`

`author`	`string`
`created_at`	`integer`
`message`	`string`
`title`	`string`
`version`	`integer`

curl https://work.nightroll.app/api/v1/pages.versions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

pages.viewread

REST POST /api/v1/pages.view · MCP tool pages_view · scopes pages:read

Input

idrequired string

Output `object`

views integer

curl https://work.nightroll.app/api/v1/pages.view \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":"<id>"}'

plugins

plugins.actionread

REST POST /api/v1/plugins.action · MCP tool plugins_action · scopes plugins:read

Input

`action`required	`string`
`context`	`any`
`input`	`any`
`plugin`required	`string`

Output `object`

`error`	`string`
`logs`	`string[]`
`ok`	`boolean`
`value`	`any`

curl https://work.nightroll.app/api/v1/plugins.action \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"action":"<action>","plugin":"<plugin>"}'

plugins.callread

REST POST /api/v1/plugins.call · MCP tool plugins_call · scopes plugins:read

Input

`input`	`any`
`op`required	`string`
`plugin`required	`string`

Output `object`

`error`	`string`
`logs`	`string[]`
`ok`	`boolean`
`value`	`any`

curl https://work.nightroll.app/api/v1/plugins.call \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"op":"<op>","plugin":"<plugin>"}'

plugins.enablewrite

REST POST /api/v1/plugins.enable · MCP tool plugins_enable · scopes admin

Input

`enabled`required	`boolean`
`key`required	`string`

Output `object`

`allow`	`string[]`
`description`	`string`
`enabled`	`boolean`
`events`	`object[]`
`installed_at`	`integer`
`installed_by`	`string`
`key`	`string`
`listing`	`integer`
`name`	`string`
`ops`	`object[]`
`permissions`	`string[]`
`publisher`	`string`	Signed bundles: the publisher's key, and the marketplace listing it came from.
`runtime`	`string`	rhai \| wasm
`settings`	`object[]`
`token_prefix`	`string`	First characters of the install token.
`ui`	`object`	Where a plugin shows up in the app.
`updated_at`	`integer`
`version`	`string`

curl https://work.nightroll.app/api/v1/plugins.enable \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"enabled":true,"key":"<key>"}'

plugins.http_resultwrite

REST POST /api/v1/plugins.http_result · MCP tool plugins_http_result · scopes system

Input

`body`	`string`
`error`	`string`
`id`required	`integer`
`status`required	`integer`	0 = no answer.

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/plugins.http_result \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"status":1}'

plugins.http_takewrite

REST POST /api/v1/plugins.http_take · MCP tool plugins_http_take · scopes system

Input

idrequired integer

Output `object`

`body`	`string`
`gone`	`boolean`	Gone (uninstalled, disabled, or already sent): nothing to do.
`headers`	`any[][]`
`method`	`string`
`url`	`string`

curl https://work.nightroll.app/api/v1/plugins.http_take \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

plugins.installwrite

REST POST /api/v1/plugins.install · MCP tool plugins_install · scopes admin

Input

`manifest`	`object`	With `source` or `wasm`; or give `signed` instead.
`settings`	`object`	Setting values by key.
`signed`	`object`	A signed bundle (W616): `bundle` is the JSON text `{manifest, source \| wasm}`, signed (Ed25519) by `publisher`.
`source`	`string`	Rhai source defining the handlers (`fn estimate(input) { … }`).
`wasm`	`string`	Or a Wasm module, base64.

Output `object`

`plugin`	`object`
`token`	`string`	The install token (new installs and rotations only; shown once): `Authorization: Bearer kbp_…` for the plugin's own backend.

curl https://work.nightroll.app/api/v1/plugins.install \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

plugins.listread

REST POST /api/v1/plugins.list · MCP tool plugins_list · scopes plugins:read

Input

None: send {}.

Output `object[]`

`allow`	`string[]`
`description`	`string`
`enabled`	`boolean`
`events`	`object[]`
`installed_at`	`integer`
`installed_by`	`string`
`key`	`string`
`listing`	`integer`
`name`	`string`
`ops`	`object[]`
`permissions`	`string[]`
`publisher`	`string`	Signed bundles: the publisher's key, and the marketplace listing it came from.
`runtime`	`string`	rhai \| wasm
`settings`	`object[]`
`token_prefix`	`string`	First characters of the install token.
`ui`	`object`	Where a plugin shows up in the app.
`updated_at`	`integer`
`version`	`string`

curl https://work.nightroll.app/api/v1/plugins.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

plugins.renderread

REST POST /api/v1/plugins.render · MCP tool plugins_render · scopes plugins:read

Input

`context`	`any`	What it's shown for: issue panels `{key}`, card badges `{keys}`, page macros `{page, params}`, commands `{issue?, page?, path, selection?}`, gadgets `{dashboard}`.
`key`required	`string`
`plugin`required	`string`
`slot`required	`string`	issue_panel \| card_badge \| page_macro \| command \| gadget

Output `object`

`error`	`string`
`logs`	`string[]`
`ok`	`boolean`
`value`	`any`

curl https://work.nightroll.app/api/v1/plugins.render \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","plugin":"<plugin>","slot":"<slot>"}'

plugins.runswrite

REST POST /api/v1/plugins.runs · MCP tool plugins_runs · scopes admin

Input

keyrequired string

Output `object[]`

`at`	`integer`
`by`	`string`
`calls`	`string[]`
`error`	`string`
`fuel`	`integer`
`handler`	`string`
`id`	`integer`
`logs`	`string[]`
`ms`	`integer`
`ok`	`boolean`
`trigger`	`string`

curl https://work.nightroll.app/api/v1/plugins.runs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

plugins.settings_savewrite

REST POST /api/v1/plugins.settings_save · MCP tool plugins_settings_save · scopes admin

Input

`key`required	`string`
`settings`required	`object`	Values by setting key; a secret left out keeps its value.

Output `object`

`allow`	`string[]`
`description`	`string`
`enabled`	`boolean`
`events`	`object[]`
`installed_at`	`integer`
`installed_by`	`string`
`key`	`string`
`listing`	`integer`
`name`	`string`
`ops`	`object[]`
`permissions`	`string[]`
`publisher`	`string`	Signed bundles: the publisher's key, and the marketplace listing it came from.
`runtime`	`string`	rhai \| wasm
`settings`	`object[]`
`token_prefix`	`string`	First characters of the install token.
`ui`	`object`	Where a plugin shows up in the app.
`updated_at`	`integer`
`version`	`string`

curl https://work.nightroll.app/api/v1/plugins.settings_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","settings":"<settings>"}'

plugins.signwrite

REST POST /api/v1/plugins.sign · MCP tool plugins_sign · scopes admin

Input

`manifest`required	`object`	What a plugin is and may do.
`source`	`string`
`wasm`	`string`

Output `object`

`bundle`	`string`	The bundle text: submit it as is (`market.submit`), or install it (`plugins.install {signed}`).
`publisher`	`string`	This org's publisher key (hex).
`sha256`	`string`
`signature`	`string`

curl https://work.nightroll.app/api/v1/plugins.sign \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"manifest":"<manifest>"}'

plugins.token_rotatewrite

REST POST /api/v1/plugins.token_rotate · MCP tool plugins_token_rotate · scopes admin

Input

keyrequired string

Output `object`

`plugin`	`object`
`token`	`string`	The install token (new installs and rotations only; shown once): `Authorization: Bearer kbp_…` for the plugin's own backend.

curl https://work.nightroll.app/api/v1/plugins.token_rotate \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

plugins.toolsread

REST POST /api/v1/plugins.tools · MCP tool plugins_tools · scopes plugins:read

Input

None: send {}.

Output `object[]`

`description`	`string`
`input`	`any`
`op`	`string`
`plugin`	`string`
`plugin_name`	`string`
`writes`	`boolean`	Whether it may change data (its scope is a write scope or admin).

curl https://work.nightroll.app/api/v1/plugins.tools \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

plugins.uiread

REST POST /api/v1/plugins.ui · MCP tool plugins_ui · scopes plugins:read

Input

None: send {}.

Output `object[]`

`description`	`string`
`key`	`string`
`plugin`	`string`
`plugin_name`	`string`
`slot`	`string`	issue_panel \| card_badge \| page_macro \| command \| gadget
`title`	`string`
`where`	`string[]`	Commands: palette and/or slash.

curl https://work.nightroll.app/api/v1/plugins.ui \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

plugins.uninstallwrite

REST POST /api/v1/plugins.uninstall · MCP tool plugins_uninstall · scopes admin

Input

keyrequired string

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/plugins.uninstall \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

poker

poker.acceptwrite

REST POST /api/v1/poker.accept · MCP tool poker_accept · scopes issues:write

Input

`id`required	`integer`
`points`required	`number`

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.accept \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"points":1}'

poker.addwrite

REST POST /api/v1/poker.add · MCP tool poker_add · scopes issues:write

Input

`id`required	`integer`
`keys`required	`string[]`

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.add \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"keys":[]}'

poker.closewrite

REST POST /api/v1/poker.close · MCP tool poker_close · scopes issues:write

Input

idrequired integer

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.close \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

poker.createwrite

REST POST /api/v1/poker.create · MCP tool poker_create · scopes issues:write

Input

`keys`	`string[]`	Issue keys, in order.
`name`	`string`
`project`required	`string`
`scale`	`string[]`	Card values (default 0, ½, 1, 2, 3, 5, 8, 13, 20, 40, ?, ☕).
`sprint`	`integer`	Estimate this sprint's issues without points (default when `keys` is empty: the backlog's top 10 without points).

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.create \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

poker.deletedestructive

REST POST /api/v1/poker.delete · MCP tool poker_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/poker.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

poker.getread

REST POST /api/v1/poker.get · MCP tool poker_get · scopes issues:read

Input

idrequired integer

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

poker.gowrite

REST POST /api/v1/poker.go · MCP tool poker_go · scopes issues:write

Input

`id`required	`integer`
`key`	`string`	Issue key; omit for the next one without an estimate.

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.go \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

poker.revealwrite

REST POST /api/v1/poker.reveal · MCP tool poker_reveal · scopes issues:write

Input

idrequired integer

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.reveal \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

poker.revotewrite

REST POST /api/v1/poker.revote · MCP tool poker_revote · scopes issues:write

Input

idrequired integer

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.revote \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

poker.sessionsread

REST POST /api/v1/poker.sessions · MCP tool poker_sessions · scopes issues:read

Input

projectrequired string

Output `object[]`

`created_at`	`integer`
`estimated`	`integer`
`facilitator`	`string`
`id`	`integer`
`items`	`integer`
`name`	`string`
`sprint`	`integer`
`state`	`string`

curl https://work.nightroll.app/api/v1/poker.sessions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

poker.votewrite

REST POST /api/v1/poker.vote · MCP tool poker_vote · scopes issues:write

Input

`id`required	`integer`
`value`required	`string`	A card of the session's scale; empty takes your vote back.

Output `object`

`can_run`	`boolean`	The caller runs it (facilitator, or a project admin).
`can_vote`	`boolean`	The caller may vote (edits the project).
`created_at`	`integer`
`current`	`string`	The issue being estimated.
`current_description`	`string`
`facilitator`	`string`
`id`	`integer`
`items`	`object[]`
`name`	`string`
`project`	`string`
`revealed`	`boolean`
`scale`	`string[]`
`sprint`	`integer`
`state`	`string`	open \| closed
`stats`	`object`
`votes`	`object[]`

curl https://work.nightroll.app/api/v1/poker.vote \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1,"value":"<value>"}'

roadmap

roadmap.changelogread

REST POST /api/v1/roadmap.changelog · MCP tool roadmap_changelog · scopes roadmap:read

Input

None: send {}.

Output `object[]`

`body`	`string`	Markdown.
`created_at`	`integer`
`id`	`integer`
`project`	`string`
`public`	`boolean`	Published (public).
`published_at`	`integer`
`title`	`string`
`version`	`integer`	The released version it was drafted from.

curl https://work.nightroll.app/api/v1/roadmap.changelog \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

roadmap.changelog_deletedestructive

REST POST /api/v1/roadmap.changelog_delete · MCP tool roadmap_changelog_delete · scopes roadmap:write

Input

idrequired integer

Output `object`

ok boolean

curl https://work.nightroll.app/api/v1/roadmap.changelog_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

roadmap.changelog_savewrite

REST POST /api/v1/roadmap.changelog_save · MCP tool roadmap_changelog_save · scopes roadmap:write

Input

`body`	`string`
`id`	`integer`
`public`	`boolean`	Publish it (true) or keep it a draft.
`title`required	`string`

Output `object[]`

`body`	`string`	Markdown.
`created_at`	`integer`
`id`	`integer`
`project`	`string`
`public`	`boolean`	Published (public).
`published_at`	`integer`
`title`	`string`
`version`	`integer`	The released version it was drafted from.

curl https://work.nightroll.app/api/v1/roadmap.changelog_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"title":"<title>"}'

roadmap.item_deletedestructive

REST POST /api/v1/roadmap.item_delete · MCP tool roadmap_item_delete · scopes roadmap:write

Input

idrequired integer

Output `object[]`

`column`	`string`	now \| next \| later \| shipped: where it shows.
`column_set`	`string`	auto (from the linked issues), or the column set by hand.
`description`	`string`
`done`	`integer`	Linked issues done / all.
`id`	`integer`
`idea`	`integer`	The feedback idea it answers, and its votes.
`issues`	`string[]`	Linked issue keys (team view only).
`position`	`number`
`public`	`boolean`	Shown on the public roadmap.
`title`	`string`
`total`	`integer`
`updated_at`	`integer`
`votes`	`integer`

curl https://work.nightroll.app/api/v1/roadmap.item_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

roadmap.item_savewrite

REST POST /api/v1/roadmap.item_save · MCP tool roadmap_item_save · scopes roadmap:write

Input

`column`	`string`	auto \| now \| next \| later \| shipped
`description`	`string`
`id`	`integer`
`idea`	`integer`	A feedback idea id.
`issues`	`string[]`	Issue keys that deliver it (replaces the list).
`position`	`number`
`public`	`boolean`
`title`required	`string`

Output `object[]`

`column`	`string`	now \| next \| later \| shipped: where it shows.
`column_set`	`string`	auto (from the linked issues), or the column set by hand.
`description`	`string`
`done`	`integer`	Linked issues done / all.
`id`	`integer`
`idea`	`integer`	The feedback idea it answers, and its votes.
`issues`	`string[]`	Linked issue keys (team view only).
`position`	`number`
`public`	`boolean`	Shown on the public roadmap.
`title`	`string`
`total`	`integer`
`updated_at`	`integer`
`votes`	`integer`

curl https://work.nightroll.app/api/v1/roadmap.item_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"title":"<title>"}'

roadmap.itemsread

REST POST /api/v1/roadmap.items · MCP tool roadmap_items · scopes roadmap:read

Input

None: send {}.

Output `object[]`

`column`	`string`	now \| next \| later \| shipped: where it shows.
`column_set`	`string`	auto (from the linked issues), or the column set by hand.
`description`	`string`
`done`	`integer`	Linked issues done / all.
`id`	`integer`
`idea`	`integer`	The feedback idea it answers, and its votes.
`issues`	`string[]`	Linked issue keys (team view only).
`position`	`number`
`public`	`boolean`	Shown on the public roadmap.
`title`	`string`
`total`	`integer`
`updated_at`	`integer`
`votes`	`integer`

curl https://work.nightroll.app/api/v1/roadmap.items \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

roadmap.publicwrite

REST POST /api/v1/roadmap.public · MCP tool roadmap_public · scopes desk:public | roadmap:read

Input

None: send {}.

Output `object`

`changelog`	`object[]`	Published changelog entries, newest first (≤ 50).
`items`	`object[]`	Public items by column: now, next, later, shipped.

curl https://work.nightroll.app/api/v1/roadmap.public \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

scripts

scripts.deletedestructive

REST POST /api/v1/scripts.delete · MCP tool scripts_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/scripts.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

scripts.listwrite

REST POST /api/v1/scripts.list · MCP tool scripts_list · scopes admin

Input

None: send {}.

Output `object[]`

`code`	`string`
`description`	`string`
`enabled`	`boolean`
`events`	`string[]`	listener: event kinds (`issue.created`, `issue.`, ``).
`field`	`string`	field: the custom field key it computes.
`id`	`integer`
`kind`	`string`	console \| listener \| field \| tql
`name`	`string`
`run_as`	`string`	Whose permissions it runs with (the admin who last saved it).
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/scripts.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

scripts.runwrite

REST POST /api/v1/scripts.run · MCP tool scripts_run · scopes admin

Input

`code`required	`string`
`input`	`any`	Bound to `input` in the script.

Output `object`

`calls`	`string[]`	Ops it called, in order.
`error`	`string`
`fuel`	`integer`
`logs`	`string[]`
`ms`	`integer`
`run`	`integer`
`value`	`any`	The script's last expression.

curl https://work.nightroll.app/api/v1/scripts.run \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"code":"<code>"}'

scripts.runswrite

REST POST /api/v1/scripts.runs · MCP tool scripts_runs · scopes admin

Input

id integer A script's runs, or console runs when omitted.

Output `object[]`

`at`	`integer`
`by`	`string`
`calls`	`string[]`
`error`	`string`
`fuel`	`integer`
`id`	`integer`
`logs`	`string[]`
`ms`	`integer`
`ok`	`boolean`
`trigger`	`string`
`value`	`string`

curl https://work.nightroll.app/api/v1/scripts.runs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

scripts.savewrite

REST POST /api/v1/scripts.save · MCP tool scripts_save · scopes admin

Input

`code`required	`string`
`description`	`string`
`enabled`	`boolean`
`events`	`string[]`
`field`	`string`
`id`	`integer`
`kind`required	`string`	console \| listener \| field \| tql
`name`required	`string`

Output `object[]`

`code`	`string`
`description`	`string`
`enabled`	`boolean`
`events`	`string[]`	listener: event kinds (`issue.created`, `issue.`, ``).
`field`	`string`	field: the custom field key it computes.
`id`	`integer`
`kind`	`string`	console \| listener \| field \| tql
`name`	`string`
`run_as`	`string`	Whose permissions it runs with (the admin who last saved it).
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/scripts.save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"code":"<code>","kind":"<kind>","name":"<name>"}'

scripts.testwrite

REST POST /api/v1/scripts.test · MCP tool scripts_test · scopes admin

Input

`id`required	`integer`
`input`	`any`	Overrides the input (default: a sample for the kind — the last event / an issue key's issue / no args).
`key`	`string`	field scripts: run against this issue.

Output `object`

`calls`	`string[]`	Ops it called, in order.
`error`	`string`
`fuel`	`integer`
`logs`	`string[]`
`ms`	`integer`
`run`	`integer`
`value`	`any`	The script's last expression.

curl https://work.nightroll.app/api/v1/scripts.test \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

search

search.queryreadWords to find (every word must match; the last one may be the start of a word).

REST POST /api/v1/search.query · MCP tool search_query · scopes search:read

Input

`kinds`	`string[]`	Only these subject kinds (`issue`, `page`).
`limit`	`integer`	1-50, default 20.
`q`required	`string`

Output `object[]`

`kind`	`string`
`snippet`	`string`	Text around the match; `[` `]` mark matched words.
`subject`	`string`	`kind:id`, e.g. `issue:12`.
`title`	`string`
`url`	`string`	Where it lives in the app (`https://…/<org>/issues/WEB-1`), when it has a page.

curl https://work.nightroll.app/api/v1/search.query \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"q":"<q>"}'

search.reindexwrite

REST POST /api/v1/search.reindex · MCP tool search_reindex · scopes admin

Input

None: send {}.

Output `any`

curl https://work.nightroll.app/api/v1/search.reindex \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

search.similarread

REST POST /api/v1/search.similar · MCP tool search_similar · scopes search:read

Input

`kinds`	`string[]`
`limit`	`integer`	1-50, default 10.
`min_score`	`number`	Drop matches scoring below this (cosine, default 0.6; ~0.75+ for likely duplicates).
`subject`	`string`	…or an existing subject (`issue:12`): what's like it (itself left out).
`text`	`string`	Natural-language text to match by meaning…

Output `object`

`hits`	`object[]`
`ready`	`boolean`	False while the embedding model loads; `hits` is empty then (use `search.query`).

curl https://work.nightroll.app/api/v1/search.similar \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

search.vectorsread

REST POST /api/v1/search.vectors · MCP tool search_vectors · scopes search:read

Input

None: send {}.

Output `object`

`indexed`	`integer`	Documents with a vector, and waiting for one.
`model`	`string`
`pending`	`integer`
`ready`	`boolean`

curl https://work.nightroll.app/api/v1/search.vectors \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

sla

sla.calendar_deletedestructive

REST POST /api/v1/sla.calendar_delete · MCP tool sla_calendar_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/sla.calendar_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

sla.calendar_savewrite

REST POST /api/v1/sla.calendar_save · MCP tool sla_calendar_save · scopes admin

Input

`holidays`	`string[]`	YYYY-MM-DD days off.
`hours`required	`object`	Weekday ("0" Sunday … "6" Saturday) → ["HH:MM", "HH:MM"] working hours; missing days are off.
`id`	`integer`
`name`required	`string`
`tz_offset`required	`integer`	Minutes behind UTC (as `Date.getTimezoneOffset()` gives it): 300 for New York in winter, -60 for Paris.

Output `object[]`

`holidays`	`string[]`	YYYY-MM-DD days off.
`hours`	`object`	Weekday ("0" Sunday … "6" Saturday) → ["HH:MM", "HH:MM"] working hours; missing days are off.
`id`	`integer`
`name`	`string`
`tz_offset`	`integer`	Minutes behind UTC (as `Date.getTimezoneOffset()` gives it): 300 for New York in winter, -60 for Paris.

curl https://work.nightroll.app/api/v1/sla.calendar_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"hours":"<hours>","name":"<name>","tz_offset":1}'

sla.calendarsread

REST POST /api/v1/sla.calendars · MCP tool sla_calendars · scopes issues:read

Input

None: send {}.

Output `object[]`

`holidays`	`string[]`	YYYY-MM-DD days off.
`hours`	`object`	Weekday ("0" Sunday … "6" Saturday) → ["HH:MM", "HH:MM"] working hours; missing days are off.
`id`	`integer`
`name`	`string`
`tz_offset`	`integer`	Minutes behind UTC (as `Date.getTimezoneOffset()` gives it): 300 for New York in winter, -60 for Paris.

curl https://work.nightroll.app/api/v1/sla.calendars \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

sla.issueread

REST POST /api/v1/sla.issue · MCP tool sla_issue · scopes issues:read

Input

keyrequired string

Output `object[]`

`calendar`	`string`
`due_at`	`integer`	When it breaches (running clocks; unix seconds).
`elapsed_minutes`	`integer`
`metric`	`string`
`name`	`string`
`policy`	`integer`
`remaining_minutes`	`integer`	Negative once breached.
`started_at`	`integer`
`state`	`string`	running \| met \| breached (stopped late, or still running past the target)
`stopped_at`	`integer`
`target_minutes`	`integer`

curl https://work.nightroll.app/api/v1/sla.issue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

sla.policiesread

REST POST /api/v1/sla.policies · MCP tool sla_policies · scopes issues:read

Input

None: send {}.

Output `object[]`

`calendar`	`integer`
`enabled`	`boolean`
`id`	`integer`
`kinds`	`string[]`
`metric`	`string`	first_response (stops at the first comment by someone other than the reporter) \| resolution (stops when resolved)
`name`	`string`
`priorities`	`string[]`
`projects`	`string[]`	Empty = every project / type / priority.
`since`	`integer`	Applies to issues created from this time (unix seconds).
`target_minutes`	`integer`	Business minutes allowed.

curl https://work.nightroll.app/api/v1/sla.policies \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

sla.policy_deletedestructive

REST POST /api/v1/sla.policy_delete · MCP tool sla_policy_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/sla.policy_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

sla.policy_savewrite

REST POST /api/v1/sla.policy_save · MCP tool sla_policy_save · scopes admin

Input

`calendar`required	`integer`
`enabled`	`boolean`
`id`	`integer`
`kinds`	`string[]`
`metric`required	`string`	first_response (stops at the first comment by someone other than the reporter) \| resolution (stops when resolved)
`name`required	`string`
`priorities`	`string[]`
`projects`	`string[]`	Empty = every project / type / priority.
`since`	`integer`	Applies to issues created from this time (unix seconds).
`target_minutes`required	`integer`	Business minutes allowed.

Output `object[]`

`calendar`	`integer`
`enabled`	`boolean`
`id`	`integer`
`kinds`	`string[]`
`metric`	`string`	first_response (stops at the first comment by someone other than the reporter) \| resolution (stops when resolved)
`name`	`string`
`priorities`	`string[]`
`projects`	`string[]`	Empty = every project / type / priority.
`since`	`integer`	Applies to issues created from this time (unix seconds).
`target_minutes`	`integer`	Business minutes allowed.

curl https://work.nightroll.app/api/v1/sla.policy_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"calendar":1,"metric":"<metric>","name":"<name>","target_minutes":1}'

sla.reportread

REST POST /api/v1/sla.report · MCP tool sla_report · scopes issues:read

Input

`days`	`integer`	Clocks started in the last N days (default 30).
`project`	`string`	Only this project.

Output `object[]`

`avg_minutes`	`integer`
`breached`	`integer`
`met`	`integer`
`met_pct`	`integer`	met / (met + breached) × 100; null with nothing finished.
`name`	`string`
`policy`	`integer`
`running`	`integer`

curl https://work.nightroll.app/api/v1/sla.report \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

staging

staging.applywrite

REST POST /api/v1/staging.apply · MCP tool staging_apply · scopes system

Input

`changes`required	`object[]`
`from`required	`string`	The staging org's slug (for the event).

Output `any`

curl https://work.nightroll.app/api/v1/staging.apply \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"changes":[],"from":"<from>"}'

staging.configwrite

REST POST /api/v1/staging.config · MCP tool staging_config · scopes system

Input

None: send {}.

Output `object`

`base`	`object`	The configuration at the copy (empty outside staging orgs).
`tables`	`object`

curl https://work.nightroll.app/api/v1/staging.config \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

staging.preparewrite

REST POST /api/v1/staging.prepare · MCP tool staging_prepare · scopes system

Input

`data`required	`string`	none \| anonymized
`owner`required	`string`	Who sample issues are assigned to.

Output `any`

curl https://work.nightroll.app/api/v1/staging.prepare \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"data":"<data>","owner":"<owner>"}'

staging.rebasewrite

REST POST /api/v1/staging.rebase · MCP tool staging_rebase · scopes system

Input

`changes`required	`object[]`
`from`required	`string`	The staging org's slug (for the event).

Output `any`

curl https://work.nightroll.app/api/v1/staging.rebase \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"changes":[],"from":"<from>"}'

tests

tests.caseread

REST POST /api/v1/tests.case · MCP tool tests_case · scopes issues:read

Input

keyrequired string

Output `object`

`automation_id`	`string`	Matches imported results: JUnit `classname.name`, xUnit test name, Cucumber `feature;scenario` id.
`covers`	`string[]`	Requirement keys it covers.
`folder`	`string`	A path like "Checkout/Payments" ("" = top level).
`id`	`integer`
`key`	`string`	`{project}-T{number}`, e.g. "WEB-T12".
`last_run_at`	`integer`
`last_status`	`string`	Its latest result anywhere: pass \| fail \| blocked \| skip \| todo (null = never run).
`preconditions`	`string`
`project`	`string`
`steps`	`object[]`
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/tests.case \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

tests.case_deletedestructive

REST POST /api/v1/tests.case_delete · MCP tool tests_case_delete · scopes issues:write

Input

keyrequired string

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/tests.case_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

tests.case_savewrite

REST POST /api/v1/tests.case_save · MCP tool tests_case_save · scopes issues:write

Input

`automation_id`	`string`
`covers`	`string[]`	Requirement keys it covers (replaces).
`folder`	`string`
`key`	`string`	Omit to create (then `project` is required).
`preconditions`	`string`
`project`	`string`
`steps`	`object[]`
`title`required	`string`

Output `object`

`automation_id`	`string`	Matches imported results: JUnit `classname.name`, xUnit test name, Cucumber `feature;scenario` id.
`covers`	`string[]`	Requirement keys it covers.
`folder`	`string`	A path like "Checkout/Payments" ("" = top level).
`id`	`integer`
`key`	`string`	`{project}-T{number}`, e.g. "WEB-T12".
`last_run_at`	`integer`
`last_status`	`string`	Its latest result anywhere: pass \| fail \| blocked \| skip \| todo (null = never run).
`preconditions`	`string`
`project`	`string`
`steps`	`object[]`
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/tests.case_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"title":"<title>"}'

tests.casesread

REST POST /api/v1/tests.cases · MCP tool tests_cases · scopes issues:read

Input

`folder`	`string`	Only this folder (and below).
`project`required	`string`

Output `object[]`

`automation_id`	`string`	Matches imported results: JUnit `classname.name`, xUnit test name, Cucumber `feature;scenario` id.
`covers`	`string[]`	Requirement keys it covers.
`folder`	`string`	A path like "Checkout/Payments" ("" = top level).
`id`	`integer`
`key`	`string`	`{project}-T{number}`, e.g. "WEB-T12".
`last_run_at`	`integer`
`last_status`	`string`	Its latest result anywhere: pass \| fail \| blocked \| skip \| todo (null = never run).
`preconditions`	`string`
`project`	`string`
`steps`	`object[]`
`title`	`string`
`updated_at`	`integer`

curl https://work.nightroll.app/api/v1/tests.cases \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

tests.coverageread

REST POST /api/v1/tests.coverage · MCP tool tests_coverage · scopes issues:read

Input

`plan`	`integer`	Results within this plan only.
`project`required	`string`
`tql`	`string`	Requirements: issues matching this TQL (default: the project's open stories and tasks… everything not done).

Output `object[]`

`key`	`string`
`status`	`string`	ok \| nok \| not_run \| partial \| uncovered
`tests`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/tests.coverage \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

tests.executewrite

REST POST /api/v1/tests.execute · MCP tool tests_execute · scopes issues:write

Input

`comment`	`string`
`defects`	`string[]`
`environment`	`string`
`plan`	`integer`
`status`required	`string`
`steps`	`object[]`
`test`required	`string`

Output `object`

`comment`	`string`
`defects`	`string[]`	Issue keys of the bugs it found.
`duration_ms`	`integer`
`environment`	`string`
`executed_at`	`integer`
`executed_by`	`string`
`id`	`integer`
`plan`	`integer`
`source`	`string`	manual \| junit \| xunit \| cucumber
`status`	`string`
`steps`	`object[]`
`test`	`string`

curl https://work.nightroll.app/api/v1/tests.execute \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"status":"<status>","test":"<test>"}'

tests.for_issueread

REST POST /api/v1/tests.for_issue · MCP tool tests_for_issue · scopes issues:read

Input

keyrequired string

Output `object`

`key`	`string`
`status`	`string`	ok \| nok \| not_run \| partial \| uncovered
`tests`	`object[]`
`title`	`string`

curl https://work.nightroll.app/api/v1/tests.for_issue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

tests.importwrite

REST POST /api/v1/tests.import · MCP tool tests_import · scopes issues:write

Input

`content`required	`string`	The report file's text.
`create_missing`	`boolean`	Create cases for results that match none (default true).
`environment`	`string`
`format`required	`string`	junit \| xunit \| cucumber
`plan`	`integer`	Record the results in this plan (cases get added to it).
`project`required	`string`

Output `object`

`created`	`string[]`
`failed`	`integer`
`passed`	`integer`
`results`	`integer`
`skipped`	`integer`
`unmatched`	`string[]`	Results that matched no case (with create_missing off).

curl https://work.nightroll.app/api/v1/tests.import \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"content":"<content>","format":"<format>","project":"<project>"}'

tests.planread

REST POST /api/v1/tests.plan · MCP tool tests_plan · scopes issues:read

Input

idrequired integer

Output `object`

`can_edit`	`boolean`
`counts`	`object`	Counts per status (todo includes never run).
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`id`	`integer`
`name`	`string`
`project`	`string`
`state`	`string`
`tests`	`object[]`	Its cases with their latest result in this plan.
`version`	`string`

curl https://work.nightroll.app/api/v1/tests.plan \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

tests.plan_deletedestructive

REST POST /api/v1/tests.plan_delete · MCP tool tests_plan_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/tests.plan_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

tests.plan_savewrite

REST POST /api/v1/tests.plan_save · MCP tool tests_plan_save · scopes issues:write

Input

`description`	`string`
`id`	`integer`
`name`required	`string`
`project`required	`string`
`state`	`string`	open \| closed
`tests`	`string[]`	Test case keys, in order (replaces).
`version`	`string`	Fix version this plan tests.

Output `object`

`can_edit`	`boolean`
`counts`	`object`	Counts per status (todo includes never run).
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`id`	`integer`
`name`	`string`
`project`	`string`
`state`	`string`
`tests`	`object[]`	Its cases with their latest result in this plan.
`version`	`string`

curl https://work.nightroll.app/api/v1/tests.plan_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"name":"<name>","project":"<project>"}'

tests.plansread

REST POST /api/v1/tests.plans · MCP tool tests_plans · scopes issues:read

Input

`folder`	`string`	Only this folder (and below).
`project`required	`string`

Output `object[]`

`can_edit`	`boolean`
`counts`	`object`	Counts per status (todo includes never run).
`created_at`	`integer`
`created_by`	`string`
`description`	`string`
`id`	`integer`
`name`	`string`
`project`	`string`
`state`	`string`
`tests`	`object[]`	Its cases with their latest result in this plan.
`version`	`string`

curl https://work.nightroll.app/api/v1/tests.plans \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"project":"<project>"}'

tests.runsread

REST POST /api/v1/tests.runs · MCP tool tests_runs · scopes issues:read

Input

keyrequired string

Output `object[]`

`comment`	`string`
`defects`	`string[]`	Issue keys of the bugs it found.
`duration_ms`	`integer`
`environment`	`string`
`executed_at`	`integer`
`executed_by`	`string`
`id`	`integer`
`plan`	`integer`
`source`	`string`	manual \| junit \| xunit \| cucumber
`status`	`string`
`steps`	`object[]`
`test`	`string`

curl https://work.nightroll.app/api/v1/tests.runs \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

time

time.account_deletedestructive

REST POST /api/v1/time.account_delete · MCP tool time_account_delete · scopes admin

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/time.account_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

time.account_savewrite

REST POST /api/v1/time.account_save · MCP tool time_account_save · scopes admin

Input

`active`	`boolean`
`customer`	`string`
`id`	`integer`
`key`required	`string`
`name`required	`string`
`rate`	`number`

Output `object[]`

`active`	`boolean`
`customer`	`string`
`id`	`integer`
`key`	`string`
`name`	`string`
`rate`	`number`	Per hour, in the org's currency (approvers and admins only).

curl https://work.nightroll.app/api/v1/time.account_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>","name":"<name>"}'

time.accountsread

REST POST /api/v1/time.accounts · MCP tool time_accounts · scopes issues:read

Input

None: send {}.

Output `object[]`

`active`	`boolean`
`customer`	`string`
`id`	`integer`
`key`	`string`
`name`	`string`
`rate`	`number`	Per hour, in the org's currency (approvers and admins only).

curl https://work.nightroll.app/api/v1/time.accounts \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

time.estimatewrite

REST POST /api/v1/time.estimate · MCP tool time_estimate · scopes issues:write

Input

`key`required	`string`
`original`	`string`	Durations; "" clears.
`remaining`	`string`

Output `object`

`can_log`	`boolean`
`key`	`string`
`logs`	`object[]`
`original`	`integer`
`remaining`	`integer`	Left to do: set by hand, else original − spent (never below 0).
`spent`	`integer`	Seconds logged on the issue (and, in `with_children`, on everything under it).
`timer_started_at`	`integer`	Your timer, when it's running on this issue: when it started.
`with_children`	`integer`

curl https://work.nightroll.app/api/v1/time.estimate \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

time.issueread

REST POST /api/v1/time.issue · MCP tool time_issue · scopes issues:read

Input

keyrequired string

Output `object`

`can_log`	`boolean`
`key`	`string`
`logs`	`object[]`
`original`	`integer`
`remaining`	`integer`	Left to do: set by hand, else original − spent (never below 0).
`spent`	`integer`	Seconds logged on the issue (and, in `with_children`, on everything under it).
`timer_started_at`	`integer`	Your timer, when it's running on this issue: when it started.
`with_children`	`integer`

curl https://work.nightroll.app/api/v1/time.issue \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

time.logwrite

REST POST /api/v1/time.log · MCP tool time_log · scopes issues:write

Input

`account`	`integer`
`billable`	`boolean`
`day`	`string`	YYYY-MM-DD; default today.
`duration`required	`string`	"1h 30m", "45m", "1.5h", "2d", "1w" (a bare number = hours).
`key`required	`string`
`note`	`string`
`who`	`string`	Member id (approvers and admins only); default you.

Output `object`

`can_log`	`boolean`
`key`	`string`
`logs`	`object[]`
`original`	`integer`
`remaining`	`integer`	Left to do: set by hand, else original − spent (never below 0).
`spent`	`integer`	Seconds logged on the issue (and, in `with_children`, on everything under it).
`timer_started_at`	`integer`	Your timer, when it's running on this issue: when it started.
`with_children`	`integer`

curl https://work.nightroll.app/api/v1/time.log \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"duration":"<duration>","key":"<key>"}'

time.log_deletedestructive

REST POST /api/v1/time.log_delete · MCP tool time_log_delete · scopes issues:write

Input

idrequired integer

Output `object`

deleted integer Rows removed or moved (a project counts itself plus its issues; an option counts the issues it moved).

curl https://work.nightroll.app/api/v1/time.log_delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

time.log_updatewrite

REST POST /api/v1/time.log_update · MCP tool time_log_update · scopes issues:write

Input

`account`	`integer`	0 clears.
`billable`	`boolean`
`day`	`string`
`duration`	`string`
`id`required	`integer`
`note`	`string`

Output `object`

`can_log`	`boolean`
`key`	`string`
`logs`	`object[]`
`original`	`integer`
`remaining`	`integer`	Left to do: set by hand, else original − spent (never below 0).
`spent`	`integer`	Seconds logged on the issue (and, in `with_children`, on everything under it).
`timer_started_at`	`integer`	Your timer, when it's running on this issue: when it started.
`with_children`	`integer`

curl https://work.nightroll.app/api/v1/time.log_update \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

time.pendingread

REST POST /api/v1/time.pending · MCP tool time_pending · scopes issues:read

Input

None: send {}.

Output `object[]`

`seconds`	`integer`
`updated_at`	`integer`
`week`	`string`
`who`	`string`

curl https://work.nightroll.app/api/v1/time.pending \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

time.reportread

REST POST /api/v1/time.report · MCP tool time_report · scopes issues:read

Input

`from`required	`string`	YYYY-MM-DD, inclusive.
`group_by`required	`string`	who \| issue \| project \| epic \| account \| day
`to`required	`string`
`tql`	`string`	Only work on issues matching this TQL.
`who`	`string`	Only this person.

Output `object`

`amount`	`number`
`billable_seconds`	`integer`
`currency`	`string`
`rows`	`object[]`
`seconds`	`integer`

curl https://work.nightroll.app/api/v1/time.report \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"from":"<from>","group_by":"<group_by>","to":"<to>"}'

time.reviewwrite

REST POST /api/v1/time.review · MCP tool time_review · scopes issues:write

Input

`action`required	`string`	approve \| reject \| reopen
`note`	`string`
`week`required	`string`
`who`required	`string`

Output `object`

`can_edit`	`boolean`
`can_review`	`boolean`
`days`	`string[]`
`hours_per_day`	`number`	Hours a working day (setting).
`note`	`string`
`reviewer`	`string`
`rows`	`object[]`
`status`	`string`	open \| submitted \| approved \| rejected
`total`	`integer`
`totals`	`integer[]`	Per day, and the week.
`week`	`string`	Monday.
`who`	`string`

curl https://work.nightroll.app/api/v1/time.review \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"action":"<action>","week":"<week>","who":"<who>"}'

time.settingsread

REST POST /api/v1/time.settings · MCP tool time_settings · scopes issues:read

Input

None: send {}.

Output `object`

`approver`	`boolean`	The caller approves timesheets.
`approvers`	`string[]`	Who approves timesheets and sees rates: `everyone`, `admins`, `team:<id>`, member ids.
`can_admin`	`boolean`
`currency`	`string`
`hours_per_day`	`number`
`rates`	`object[]`	Per-person rates (override the account's).

curl https://work.nightroll.app/api/v1/time.settings \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

time.settings_savewrite

REST POST /api/v1/time.settings_save · MCP tool time_settings_save · scopes admin

Input

`approvers`required	`string[]`	Who approves timesheets and sees rates: `everyone`, `admins`, `team:<id>`, member ids.
`currency`required	`string`
`hours_per_day`required	`number`
`rates`required	`object[]`	Per-person rates (override the account's).

Output `object`

`approver`	`boolean`	The caller approves timesheets.
`approvers`	`string[]`	Who approves timesheets and sees rates: `everyone`, `admins`, `team:<id>`, member ids.
`can_admin`	`boolean`
`currency`	`string`
`hours_per_day`	`number`
`rates`	`object[]`	Per-person rates (override the account's).

curl https://work.nightroll.app/api/v1/time.settings_save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"approvers":[],"currency":"<currency>","hours_per_day":1,"rates":[]}'

time.submitwrite

REST POST /api/v1/time.submit · MCP tool time_submit · scopes issues:write

Input

weekrequired string Any day in the week.

Output `object`

`can_edit`	`boolean`
`can_review`	`boolean`
`days`	`string[]`
`hours_per_day`	`number`	Hours a working day (setting).
`note`	`string`
`reviewer`	`string`
`rows`	`object[]`
`status`	`string`	open \| submitted \| approved \| rejected
`total`	`integer`
`totals`	`integer[]`	Per day, and the week.
`week`	`string`	Monday.
`who`	`string`

curl https://work.nightroll.app/api/v1/time.submit \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"week":"<week>"}'

time.timerread

REST POST /api/v1/time.timer · MCP tool time_timer · scopes issues:read

Input

None: send {}.

Output `object`

`key`	`string`
`note`	`string`
`started_at`	`integer`
`title`	`string`

curl https://work.nightroll.app/api/v1/time.timer \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

time.timer_startwrite

REST POST /api/v1/time.timer_start · MCP tool time_timer_start · scopes issues:write

Input

`key`required	`string`
`note`	`string`

Output `object`

`key`	`string`
`note`	`string`
`started_at`	`integer`
`title`	`string`

curl https://work.nightroll.app/api/v1/time.timer_start \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"key":"<key>"}'

time.timer_stopwrite

REST POST /api/v1/time.timer_stop · MCP tool time_timer_stop · scopes issues:write

Input

`discard`	`boolean`	Throw the timer away instead of logging it.
`note`	`string`	Replaces the note given at start.

Output `object`

`key`	`string`
`note`	`string`
`started_at`	`integer`
`title`	`string`

curl https://work.nightroll.app/api/v1/time.timer_stop \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

time.timesheetread

REST POST /api/v1/time.timesheet · MCP tool time_timesheet · scopes issues:read

Input

`week`	`string`	Any day in the week; default this week.
`who`	`string`	Member id; default you (approvers can see anyone's).

Output `object`

`can_edit`	`boolean`
`can_review`	`boolean`
`days`	`string[]`
`hours_per_day`	`number`	Hours a working day (setting).
`note`	`string`
`reviewer`	`string`
`rows`	`object[]`
`status`	`string`	open \| submitted \| approved \| rejected
`total`	`integer`
`totals`	`integer[]`	Per day, and the week.
`week`	`string`	Monday.
`who`	`string`

curl https://work.nightroll.app/api/v1/time.timesheet \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

usage

usage.getread

REST POST /api/v1/usage.get · MCP tool usage_get · scopes usage:read

Input

None: send {}.

Output `object`

`current`	`object[]`	Every metric this month, with the plan's limit (null = none).
`history`	`object[]`	The last six months, newest first.
`plan`	`string`	free \| paid.

curl https://work.nightroll.app/api/v1/usage.get \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

usage.record_hourwrite

REST POST /api/v1/usage.record_hour · MCP tool usage_record_hour · scopes system

Input

`cpu_ms`required	`integer`
`hour`required	`integer`	Unix time / 3600.
`messages`required	`integer`
`sockets_peak`required	`integer`
`storage_bytes`required	`integer`

Output `any`

curl https://work.nightroll.app/api/v1/usage.record_hour \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"cpu_ms":1,"hour":1,"messages":1,"sockets_peak":1,"storage_bytes":1}'

usage.resourcesread

REST POST /api/v1/usage.resources · MCP tool usage_resources · scopes usage:read

Input

None: send {}.

Output `object`

`day`	`object`	The last 24 hours.
`last_month`	`object`	Last month (UTC), for invoices.
`month`	`object`	This month (UTC).

curl https://work.nightroll.app/api/v1/usage.resources \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

webhooks

webhooks.attemptwrite

REST POST /api/v1/webhooks.attempt · MCP tool webhooks_attempt · scopes admin

Input

idrequired integer

Output `object`

`body`	`string`
`event`	`string`
`id`	`integer`
`owner`	`string`	A member's subscription: send only if they can see `subject` (checked by the cell as them).
`secret`	`string`
`subject`	`string`
`url`	`string`

curl https://work.nightroll.app/api/v1/webhooks.attempt \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

webhooks.deletedestructive

REST POST /api/v1/webhooks.delete · MCP tool webhooks_delete · scopes admin

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/webhooks.delete \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

webhooks.deliverieswrite

REST POST /api/v1/webhooks.deliveries · MCP tool webhooks_deliveries · scopes admin

Input

hook integer One webhook's deliveries; omit for all (including automation web requests).

Output `object[]`

`attempts`	`integer`
`body`	`string`	The JSON sent (CloudEvents 1.0).
`created_at`	`integer`
`done_at`	`integer`
`event`	`string`
`hook`	`integer`
`id`	`integer`
`last_code`	`integer`
`last_error`	`string`
`next_at`	`integer`
`state`	`string`	pending \| ok \| failed
`url`	`string`

curl https://work.nightroll.app/api/v1/webhooks.deliveries \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

webhooks.eventsread

REST POST /api/v1/webhooks.events · MCP tool webhooks_events · scopes webhooks:read

Input

None: send {}.

Output `object[]`

`kind`	`string`	e.g. issue.created
`label`	`string`
`subject`	`string`	What it is about: issue, page, …

curl https://work.nightroll.app/api/v1/webhooks.events \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

webhooks.listwrite

REST POST /api/v1/webhooks.list · MCP tool webhooks_list · scopes admin

Input

None: send {}.

Output `object[]`

`active`	`boolean`
`app`	`string`	What made it: zapier \| n8n \| make \| other ("" for admin webhooks).
`created_at`	`integer`
`created_by`	`string`
`events`	`string[]`	Event kinds, e.g. "issue.created", "issue.", or "" for everything.
`id`	`integer`
`name`	`string`
`owner`	`string`	The member whose subscription this is (it sends only what they can see); null = an org-wide admin webhook.
`recent_failures`	`integer`	Deliveries that ended in failure in the last 7 days.
`secret`	`string`	Shared secret: each request carries `X-Work-Signature: sha256=<hex HMAC-SHA256(secret, body)>`.
`url`	`string`

curl https://work.nightroll.app/api/v1/webhooks.list \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

webhooks.redeliverwrite

REST POST /api/v1/webhooks.redeliver · MCP tool webhooks_redeliver · scopes admin

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/webhooks.redeliver \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

webhooks.resultwrite

REST POST /api/v1/webhooks.result · MCP tool webhooks_result · scopes admin

Input

`code`	`integer`	HTTP status, if a response came back.
`error`	`string`	Transport error, if any.
`id`required	`integer`
`last`	`boolean`	No more attempts follow: a failure is final.
`owner_gone`	`boolean`	The subscriber left the org: the subscription is switched off too.
`skipped`	`boolean`	Not sent: the subscriber can't see the event (the delivery is dropped).

Output `object`

ok boolean 2xx came back.

curl https://work.nightroll.app/api/v1/webhooks.result \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

webhooks.savewrite

REST POST /api/v1/webhooks.save · MCP tool webhooks_save · scopes admin

Input

`active`	`boolean`
`events`	`string[]`	Event kinds ("issue.created", "issue.", "").
`id`	`integer`	Omit to create.
`name`	`string`
`rotate_secret`	`boolean`	true makes a new secret.
`url`	`string`

Output `object`

`active`	`boolean`
`app`	`string`	What made it: zapier \| n8n \| make \| other ("" for admin webhooks).
`created_at`	`integer`
`created_by`	`string`
`events`	`string[]`	Event kinds, e.g. "issue.created", "issue.", or "" for everything.
`id`	`integer`
`name`	`string`
`owner`	`string`	The member whose subscription this is (it sends only what they can see); null = an org-wide admin webhook.
`recent_failures`	`integer`	Deliveries that ended in failure in the last 7 days.
`secret`	`string`	Shared secret: each request carries `X-Work-Signature: sha256=<hex HMAC-SHA256(secret, body)>`.
`url`	`string`

curl https://work.nightroll.app/api/v1/webhooks.save \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

webhooks.sendwrite

REST POST /api/v1/webhooks.send · MCP tool webhooks_send · scopes webhooks:write

Input

`body`required	`any`	JSON body to POST.
`event`	`string`	Event name for the X-Work-Event header and the log.
`url`required	`string`

Output `object`

id integer

curl https://work.nightroll.app/api/v1/webhooks.send \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"body":"<body>","url":"<url>"}'

webhooks.subscribewrite

REST POST /api/v1/webhooks.subscribe · MCP tool webhooks_subscribe · scopes webhooks:write

Input

`app`	`string`	zapier \| n8n \| make \| other
`events`required	`string[]`	Event kinds ("issue.created", "issue.", ""); see `webhooks.events`.
`name`	`string`
`url`required	`string`	Where to POST events (Zapier's targetUrl, an n8n or Make webhook URL).

Output `object`

`active`	`boolean`
`app`	`string`	What made it: zapier \| n8n \| make \| other ("" for admin webhooks).
`created_at`	`integer`
`created_by`	`string`
`events`	`string[]`	Event kinds, e.g. "issue.created", "issue.", or "" for everything.
`id`	`integer`
`name`	`string`
`owner`	`string`	The member whose subscription this is (it sends only what they can see); null = an org-wide admin webhook.
`recent_failures`	`integer`	Deliveries that ended in failure in the last 7 days.
`secret`	`string`	Shared secret: each request carries `X-Work-Signature: sha256=<hex HMAC-SHA256(secret, body)>`.
`url`	`string`

curl https://work.nightroll.app/api/v1/webhooks.subscribe \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"events":[],"url":"<url>"}'

webhooks.subscriptionsread

REST POST /api/v1/webhooks.subscriptions · MCP tool webhooks_subscriptions · scopes webhooks:read

Input

None: send {}.

Output `object[]`

`active`	`boolean`
`app`	`string`	What made it: zapier \| n8n \| make \| other ("" for admin webhooks).
`created_at`	`integer`
`created_by`	`string`
`events`	`string[]`	Event kinds, e.g. "issue.created", "issue.", or "" for everything.
`id`	`integer`
`name`	`string`
`owner`	`string`	The member whose subscription this is (it sends only what they can see); null = an org-wide admin webhook.
`recent_failures`	`integer`	Deliveries that ended in failure in the last 7 days.
`secret`	`string`	Shared secret: each request carries `X-Work-Signature: sha256=<hex HMAC-SHA256(secret, body)>`.
`url`	`string`

curl https://work.nightroll.app/api/v1/webhooks.subscriptions \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{}'

webhooks.testwrite

REST POST /api/v1/webhooks.test · MCP tool webhooks_test · scopes admin

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/webhooks.test \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

webhooks.unsubscribewrite

REST POST /api/v1/webhooks.unsubscribe · MCP tool webhooks_unsubscribe · scopes webhooks:write

Input

idrequired integer

Output `object`

id integer

curl https://work.nightroll.app/api/v1/webhooks.unsubscribe \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"id":1}'

webhooks.visibleread

REST POST /api/v1/webhooks.visible · MCP tool webhooks_visible · scopes webhooks:read

Input

subjectrequired string

Output `object`

visible boolean

curl https://work.nightroll.app/api/v1/webhooks.visible \
  -H "authorization: Bearer $WORK_TOKEN" \
  -d '{"subject":"<subject>"}'

API and MCP reference

Calling an operation

Changes, batches, streams

MCP

CLI and SDKs

VS Code

activity

Input

Output object[]

Input

Output object[]

Input

Output object

ai

Input

Output object[]

Input

Output object

Input

Output object

Input

Output object

Input

Output object

Input

Output object

Input

Output object

Input

Output object

Input

Output object[]

Input

Output object[]

Input

Output object[]

Input

Output object

Input

Output object

Input

Output object[]

Input

Output object

Input

Output object

Input

Output object

Input

Output object

Input

Output object

Input

Output object[]

analytics

Input

Output object

Input

Output object

Input

Output any

Input

Output object

Input

Output object

Input

Output object[]

api

Input

Output object

Input

Output object

approvals

Input

Output object

Input

Output object

Input

Output object[]

Input

Output `object[]`

Output `object[]`

Output `object`

Output `object[]`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object[]`

Output `object[]`

Output `object[]`

Output `object`

Output `object`

Output `object[]`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object[]`

Output `object`

Output `object`

Output `any`

Output `object`

Output `object`

Output `object[]`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object[]`

Output `object[]`

Output `object`

Output `object`

Output `object`

Output `object[]`

Output `object`

Output `object`

Output `object[]`

Output `object[]`

Output `object[]`

Output `object[]`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object[]`

Output `object`

Output `object`

Output `any`

Output `object`

Output `any`

Output `object[]`

Output `object[]`

Output `any`

Output `object`

Output `object`

Output `object`

Output `object`

Output `object[]`

Output `object`

Output `object`

Output `object[]`

Output `object`