Nexus SoftSphereDocumentation
Documentation › NexusLaw 360 › REST API

REST API for NexusLaw 360

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

134 endpoints in 44 resource groups.

accounts · ai · ap-bills · api · audit · clients · connect · currencies · custom-domain · dashboard · documents · findash · intakes · invoices · journals · kb · login · logout · matters · me · next-number · nxdocs · nxdocs-file · nxtz · offices · password · payments · perms · practice-groups · push · reports · search · sender-domains · sender-emails · sender-options · sender-prefs · sso · staff · tasks · tax-rates · time · trust · username · users

accounts 1

MethodPathAccess
GET/api/accountssigned in

ai 2

MethodPathAccess
POST/api/ai/asksigned in
GET/api/ai/statussigned in

ap-bills 3

MethodPathAccess
GET/api/ap-billssigned in
POST/api/ap-billssigned in
POST/api/ap-bills/:id/paysigned in

api 3

MethodPathAccess
GET/api/signed in
POST/api/signed in
PUT/api/signed in

audit 1

MethodPathAccess
GET/api/auditsigned in

clients 3

MethodPathAccess
GET/api/clientssigned in
POST/api/clientssigned in
PUT/api/clients/:idsigned in

connect 25

MethodPathAccess
GET/api/connect/connectionssigned in
POST/api/connect/connectionssigned in
DELETE/api/connect/connections/:idsigned in
PUT/api/connect/connections/:idsigned in
POST/api/connect/connections/:id/callsigned in
POST/api/connect/connections/:id/testsigned in
GET/api/connect/hookssigned in
POST/api/connect/hookssigned in
DELETE/api/connect/hooks/:idsigned in
PUT/api/connect/hooks/:idsigned in
GET/api/connect/hooks/:id/eventssigned in
GET/api/connect/logsigned in
GET/api/connect/metasigned in
GET/api/connect/subssigned in
POST/api/connect/subssigned in
DELETE/api/connect/subs/:idsigned in
PUT/api/connect/subs/:idsigned in
POST/api/connect/subs/:id/testadministrator
GET/api/connect/tokenssigned in
POST/api/connect/tokenssigned in
DELETE/api/connect/tokens/:idsigned in
PUT/api/connect/tokens/:idsigned in
POST/connect/hook/:slugsigned in
GET/connect/mcpsigned in
POST/connect/mcpsigned in

currencies 2

MethodPathAccess
GET/api/currenciessigned in
PUT/api/currencies/:codesigned in

custom-domain 3

MethodPathAccess
GET/api/custom-domainsigned in
PUT/api/custom-domainsigned in
POST/api/custom-domain/verifysigned in

dashboard 1

MethodPathAccess
GET/api/dashboardsigned in

documents 2

MethodPathAccess
GET/api/documentssigned in
POST/api/documentssigned in

findash 1

MethodPathAccess
GET/api/findashsigned in

intakes 4

MethodPathAccess
GET/api/intakessigned in
POST/api/intakessigned in
POST/api/intakes/:id/conflict-checksigned in
POST/api/intakes/:id/decidesigned in

invoices 7

MethodPathAccess
GET/api/invoicessigned in
GET/api/invoices/:idsigned in
POST/api/invoices/:id/emailsigned in
POST/api/invoices/:id/issuesigned in
GET/api/invoices/:id/ledessigned in
POST/api/invoices/:id/validatesigned in
POST/api/invoices/prebillsigned in

journals 3

MethodPathAccess
GET/api/journalssigned in
POST/api/journalssigned in
GET/api/journals/:idsigned in

kb 2

MethodPathAccess
GET/api/kbsigned in
POST/api/kbsigned in

login 2

MethodPathAccess
POST/api/loginpublic
POST/api/login/2fapublic

logout 1

MethodPathAccess
POST/api/logoutsigned in

matters 6

MethodPathAccess
GET/api/matterssigned in
POST/api/matterssigned in
GET/api/matters/:idsigned in
PUT/api/matters/:idsigned in
GET/api/matters/:id/ai-summarysigned in
POST/api/matters/:id/ratesigned in

me 4

MethodPathAccess
GET/api/mesigned in
POST/api/me/passwordsigned in
GET/api/me/profilesigned in
PUT/api/me/profilesigned in

next-number 1

MethodPathAccess
GET/api/next-numbersigned in

nxdocs 2

MethodPathAccess
GET/api/nxdocs/:kind/:refsigned in
POST/api/nxdocs/:kind/:refsigned in

nxdocs-file 2

MethodPathAccess
DELETE/api/nxdocs-file/:idsigned in
GET/api/nxdocs-file/:idsigned in

nxtz 3

MethodPathAccess
GET/api/nxtzsigned in
PUT/api/nxtzsigned in
POST/api/nxtz/devicesigned in

offices 2

MethodPathAccess
GET/api/officessigned in
POST/api/officessigned in

password 2

MethodPathAccess
POST/api/password/forgotpublic
POST/api/password/resetsigned in

payments 4

MethodPathAccess
GET/api/paymentssigned in
POST/api/paymentssigned in
POST/api/payments/:id/reassignsigned in
POST/api/payments/:id/voidsigned in

perms 2

MethodPathAccess
GET/api/perms/catalogsigned in
GET/api/perms/resolvedadministrator

practice-groups 2

MethodPathAccess
GET/api/practice-groupssigned in
POST/api/practice-groupssigned in

push 4

MethodPathAccess
GET/api/push/keysigned in
POST/api/push/subscribesigned in
POST/api/push/testsigned in
POST/api/push/unsubscribesigned in

reports 5

MethodPathAccess
GET/api/reports/ar-agingsigned in
GET/api/reports/profitabilitysigned in
GET/api/reports/trust-balancessigned in
GET/api/reports/utilizationsigned in
GET/api/reports/wipsigned in
MethodPathAccess
GET/api/searchsigned in
GET/api/search/coveragesigned in

sender-domains 1

MethodPathAccess
GET/api/sender-domains/:domain/dkimsigned in

sender-emails 6

MethodPathAccess
POST/api/sender-emailssigned in
DELETE/api/sender-emails/:idsigned in
PUT/api/sender-emails/:idsigned in
POST/api/sender-emails/:id/primarysigned in
POST/api/sender-emails/:id/resendsigned in
POST/api/sender-emails/:id/verifysigned in

sender-options 1

MethodPathAccess
GET/api/sender-optionssigned in

sender-prefs 1

MethodPathAccess
GET/api/sender-prefssigned in

sso 2

MethodPathAccess
GET/api/ssosigned in
POST/api/sso/accountssigned in

staff 1

MethodPathAccess
GET/api/staffsigned in

tasks 1

MethodPathAccess
POST/api/tasks/:id/donesigned in

tax-rates 1

MethodPathAccess
GET/api/tax-ratessigned in

time 5

MethodPathAccess
GET/api/timesigned in
POST/api/timesigned in
DELETE/api/time/:idsigned in
PUT/api/time/:idsigned in
POST/api/time/:id/submitsigned in

trust 4

MethodPathAccess
GET/api/trustsigned in
POST/api/trustsigned in
POST/api/trust/:id/txnsigned in
GET/api/trust/:id/txnssigned in

username 1

MethodPathAccess
POST/api/username/forgotpublic

users 3

MethodPathAccess
GET/api/usersadministrator
POST/api/usersadministrator
PUT/api/users/:idadministrator