Documentation › Nexus Projects › REST API

REST API for Nexus Projects

Every HTTP endpoint the application exposes, grouped by resource.

Calling the API

The API is served from the same address as the application, under /api. Requests carry the session cookie issued at sign-in, so a browser session and an API call are the same identity and obey the same permissions.

Every state changing request (POST, PUT, PATCH, DELETE) must also carry this application family's presence header, or it is refused with 403 bad request. That refusal reads like a permissions fault but is not one. Integration and APIs lists the header per family.

Endpoints

201 endpoints in 61 resource groups.

actions · activity · ai · allocations · benefits · billing · bu · changes · connect · contracts · custom-domain · doc-series · docs · entstruct · evm · exec · finance · fx · gates · intake · invoices · jira · login · logout · me · members · nxtz · password · perms · portfolio · portfolios · programs · proj-home · projects · provision · push · reports · resources · risks · roles · rules · search · sender-domains · sender-emails · sender-options · sender-prefs · session · settings · sprints · sso · staffing · status-reports · tasks · teams · time · username · users · vendors · whiteboard · workflow-config · workload

actions 3

Method	Path	Access
GET	`/api/actions`	signed in
POST	`/api/actions`	signed in
PUT	`/api/actions/:id`	signed in

activity 1

Method	Path	Access
GET	`/api/activity`	administrator

ai 5

Method	Path	Access
POST	`/api/ai/change-order`	administrator
GET	`/api/ai/forecast/:project_id`	signed in
GET	`/api/ai/insights`	signed in
GET	`/api/ai/insights/:project_id`	signed in
POST	`/api/ai/proposal`	administrator

allocations 3

Method	Path	Access
GET	`/api/allocations`	signed in
POST	`/api/allocations`	administrator
DELETE	`/api/allocations/:id`	administrator

benefits 2

Method	Path	Access
GET	`/api/benefits`	signed in
POST	`/api/benefits`	signed in

billing 5

Method	Path	Access
POST	`/api/billing/generate`	administrator
GET	`/api/billing/milestones`	signed in
POST	`/api/billing/milestones`	administrator
DELETE	`/api/billing/milestones/:id`	administrator
GET	`/api/billing/summary`	signed in

bu 14

Method	Path	Access
GET	`/api/bu`	signed in
GET	`/api/bu/access-preview`	administrator
POST	`/api/bu/assign-org`	administrator
POST	`/api/bu/entities`	administrator
GET	`/api/bu/for-entity`	signed in
POST	`/api/bu/functions`	administrator
GET	`/api/bu/my-access`	signed in
GET	`/api/bu/resolve`	signed in
GET	`/api/bu/security`	signed in
POST	`/api/bu/security`	administrator
POST	`/api/bu/security/assign`	administrator
POST	`/api/bu/service-providers`	administrator
POST	`/api/bu/service-providers/:id/delete`	administrator
POST	`/api/bu/units`	administrator

changes 4

Method	Path	Access
GET	`/api/changes`	signed in
POST	`/api/changes`	signed in
PUT	`/api/changes/:id`	signed in
POST	`/api/changes/:id/decide`	administrator

connect 25

Method	Path	Access
GET	`/api/connect/connections`	signed in
POST	`/api/connect/connections`	signed in
DELETE	`/api/connect/connections/:id`	signed in
PUT	`/api/connect/connections/:id`	signed in
POST	`/api/connect/connections/:id/call`	signed in
POST	`/api/connect/connections/:id/test`	signed in
GET	`/api/connect/hooks`	signed in
POST	`/api/connect/hooks`	signed in
DELETE	`/api/connect/hooks/:id`	signed in
PUT	`/api/connect/hooks/:id`	signed in
GET	`/api/connect/hooks/:id/events`	signed in
GET	`/api/connect/log`	signed in
GET	`/api/connect/meta`	signed in
GET	`/api/connect/subs`	signed in
POST	`/api/connect/subs`	signed in
DELETE	`/api/connect/subs/:id`	signed in
PUT	`/api/connect/subs/:id`	signed in
POST	`/api/connect/subs/:id/test`	administrator
GET	`/api/connect/tokens`	signed in
POST	`/api/connect/tokens`	signed in
DELETE	`/api/connect/tokens/:id`	signed in
PUT	`/api/connect/tokens/:id`	signed in
POST	`/connect/hook/:slug`	signed in
GET	`/connect/mcp`	signed in
POST	`/connect/mcp`	signed in

contracts 3

Method	Path	Access
GET	`/api/contracts`	signed in
POST	`/api/contracts`	signed in
PUT	`/api/contracts/:id`	signed in

custom-domain 3

Method	Path	Access
GET	`/api/custom-domain`	signed in
PUT	`/api/custom-domain`	signed in
POST	`/api/custom-domain/verify`	signed in

doc-series 2

Method	Path	Access
GET	`/api/doc-series`	signed in
PUT	`/api/doc-series`	administrator

docs 4

Method	Path	Access
GET	`/api/docs`	signed in
POST	`/api/docs`	signed in
GET	`/api/docs/:id`	signed in
PUT	`/api/docs/:id`	signed in

entstruct 5

Method	Path	Access
GET	`/api/entstruct`	signed in
POST	`/api/entstruct/assign`	administrator
POST	`/api/entstruct/entities`	administrator
POST	`/api/entstruct/registrations`	administrator
POST	`/api/entstruct/registrations/:id/delete`	administrator

evm 1

Method	Path	Access
GET	`/api/evm/:project_id`	signed in

exec 1

Method	Path	Access
GET	`/api/exec`	signed in

finance 3

Method	Path	Access
GET	`/api/finance`	signed in
POST	`/api/finance`	signed in
DELETE	`/api/finance/:id`	administrator

fx 3

Method	Path	Access
GET	`/api/fx`	signed in
PUT	`/api/fx/rates`	administrator
POST	`/api/fx/refresh`	administrator

gates 3

Method	Path	Access
GET	`/api/gates`	signed in
POST	`/api/gates`	signed in
POST	`/api/gates/:id/decide`	administrator

intake 6

Method	Path	Access
GET	`/api/intake`	signed in
POST	`/api/intake`	signed in
GET	`/api/intake/:id`	signed in
PUT	`/api/intake/:id`	signed in
POST	`/api/intake/:id/convert`	administrator
POST	`/api/intake/:id/decide`	administrator

invoices 3

Method	Path	Access
GET	`/api/invoices`	signed in
POST	`/api/invoices`	signed in
PUT	`/api/invoices/:id`	administrator

jira 2

Method	Path	Access
POST	`/api/jira/import`	administrator
GET	`/api/jira/status`	administrator

Method	Path	Access
POST	`/api/login`	public
POST	`/api/login/2fa`	public

logout 1

Method	Path	Access
POST	`/api/logout`	signed in

me 3

Method	Path	Access
POST	`/api/me/password`	signed in
GET	`/api/me/profile`	signed in
PUT	`/api/me/profile`	signed in

members 1

Method	Path	Access
GET	`/api/members`	signed in

nxtz 3

Method	Path	Access
GET	`/api/nxtz`	signed in
PUT	`/api/nxtz`	signed in
POST	`/api/nxtz/device`	signed in

password 2

Method	Path	Access
POST	`/api/password/forgot`	public
POST	`/api/password/reset`	signed in

perms 3

Method	Path	Access
GET	`/api/perms/catalog`	signed in
GET	`/api/perms/duties`	signed in
GET	`/api/perms/resolved`	administrator

portfolio 1

Method	Path	Access
GET	`/api/portfolio`	signed in

portfolios 3

Method	Path	Access
GET	`/api/portfolios`	signed in
POST	`/api/portfolios`	signed in
GET	`/api/portfolios/:id`	signed in

programs 2

Method	Path	Access
GET	`/api/programs`	signed in
POST	`/api/programs`	signed in

proj-home 1

Method	Path	Access
GET	`/api/proj-home`	signed in

projects 10

Method	Path	Access
GET	`/api/projects`	signed in
POST	`/api/projects`	administrator
GET	`/api/projects/:id`	signed in
PUT	`/api/projects/:id`	administrator
POST	`/api/projects/:id/baseline`	administrator
GET	`/api/projects/:id/critical-path`	signed in
GET	`/api/projects/:id/dash`	signed in
GET	`/api/projects/:id/financials`	signed in
PUT	`/api/projects/:id/fx`	administrator
GET	`/api/projects/:id/wbs`	signed in

provision 1

Method	Path	Access
POST	`/api/provision`	signed in

push 4

Method	Path	Access
GET	`/api/push/key`	signed in
POST	`/api/push/subscribe`	signed in
POST	`/api/push/test`	signed in
POST	`/api/push/unsubscribe`	signed in

reports 4

Method	Path	Access
GET	`/api/reports/bva`	signed in
GET	`/api/reports/export/:w`	signed in
GET	`/api/reports/pivot`	signed in
GET	`/api/reports/summary`	signed in

resources 3

Method	Path	Access
GET	`/api/resources`	signed in
GET	`/api/resources/capacity`	signed in
GET	`/api/resources/suggest`	signed in

risks 3

Method	Path	Access
GET	`/api/risks`	signed in
POST	`/api/risks`	signed in
PUT	`/api/risks/:id`	signed in

roles 4

Method	Path	Access
GET	`/api/roles`	signed in
POST	`/api/roles`	administrator
DELETE	`/api/roles/:id`	administrator
PUT	`/api/roles/:id`	administrator

rules 3

Method	Path	Access
GET	`/api/rules`	administrator
POST	`/api/rules`	administrator
PUT	`/api/rules/:id`	administrator

search 2

Method	Path	Access
GET	`/api/search`	signed in
GET	`/api/search/coverage`	signed in

sender-domains 1

Method	Path	Access
GET	`/api/sender-domains/:domain/dkim`	signed in

sender-emails 6

Method	Path	Access
POST	`/api/sender-emails`	signed in
DELETE	`/api/sender-emails/:id`	signed in
PUT	`/api/sender-emails/:id`	signed in
POST	`/api/sender-emails/:id/primary`	signed in
POST	`/api/sender-emails/:id/resend`	signed in
POST	`/api/sender-emails/:id/verify`	signed in

sender-options 1

Method	Path	Access
GET	`/api/sender-options`	signed in

sender-prefs 1

Method	Path	Access
GET	`/api/sender-prefs`	signed in

session 1

Method	Path	Access
GET	`/api/session`	signed in

settings 2

Method	Path	Access
GET	`/api/settings`	administrator
PUT	`/api/settings`	administrator

sprints 3

Method	Path	Access
GET	`/api/sprints`	signed in
POST	`/api/sprints`	signed in
PUT	`/api/sprints/:id`	signed in

sso 2

Method	Path	Access
GET	`/api/sso`	signed in
POST	`/api/sso/accounts`	signed in

staffing 1

Method	Path	Access
GET	`/api/staffing`	signed in

status-reports 3

Method	Path	Access
GET	`/api/status-reports`	signed in
POST	`/api/status-reports`	signed in
GET	`/api/status-reports/draft/:project_id`	signed in

tasks 5

Method	Path	Access
GET	`/api/tasks`	signed in
POST	`/api/tasks`	signed in
GET	`/api/tasks/:id`	signed in
PUT	`/api/tasks/:id`	signed in
POST	`/api/tasks/:id/comments`	signed in

teams 2

Method	Path	Access
GET	`/api/teams`	administrator
POST	`/api/teams`	administrator

time 2

Method	Path	Access
POST	`/api/time`	signed in
GET	`/api/time/summary`	signed in

username 1

Method	Path	Access
POST	`/api/username/forgot`	public

users 6

Method	Path	Access
GET	`/api/users`	administrator
POST	`/api/users`	administrator
DELETE	`/api/users/:id`	administrator
PUT	`/api/users/:id`	administrator
GET	`/api/users/:id/roles`	administrator
PUT	`/api/users/:id/roles`	administrator

vendors 2

Method	Path	Access
GET	`/api/vendors`	signed in
POST	`/api/vendors`	signed in

whiteboard 2

Method	Path	Access
GET	`/api/whiteboard/:project_id`	signed in
PUT	`/api/whiteboard/:project_id`	signed in

workflow-config 2

Method	Path	Access
GET	`/api/workflow-config`	administrator
PUT	`/api/workflow-config`	administrator

workload 1

Method	Path	Access
GET	`/api/workload`	signed in