Organization status

Read in one call whether your organization's SOM bus is set up and on, whether a spend cap has stopped paid work, and whether it uses a newsroom system.

Read the calling org's shell-wide status

GET

/api/tenant/v1/org-status

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Response Body

Org-level conditions the web shell reads on every render

application/json

response

som*

spending*

nrcs*

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/org-status'

Example Request

curl -X GET 'https://api.nuvelics.com/api/tenant/v1/org-status'

Example ResponseSchema

{
  "som": {
    "configured": true,
    "enabled": true
  },
  "spending": {
    "platform": {
      "status": "running",
      "trippedWindow": "day",
      "resetsAt": "2019-08-24T14:15:22Z"
    }
  },
  "nrcs": {
    "inUse": true
  }
}

{  "som": {    "configured": true,    "enabled": true  },  "spending": {    "platform": {      "status": "running",      "trippedWindow": "day",      "resetsAt": "2019-08-24T14:15:22Z"    }  },  "nrcs": {    "inUse": true  }}

Read the calling org's shell-wide statusCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

On this page

Read the calling org's shell-wide status

Authorization

Response Body