The one screen that says what needs attention right now.

One endpoint, with the fields it takes and the fields it gives back.

GET/today

Returns the Today homepage for one business: the headline and its ranked signal cards.

Leave entityId out only when this key can reach exactly one business. When it can reach several, a call that omits it is refused; call GET /businesses for the ids.
Reading Today also updates when each signal was last seen and closes the ones that no longer apply, exactly as opening the Today page does. Nothing in your books changes.

Needs the today:read permission. A Read only key has it.

Query parameters

entityId

Typestring

RequiredOptional

Details

a uuid

Field	Type	Required	Details
entityId	string	Optional	a uuid

Request

curl "https://www.numm.io/api/v1/today?entityId=0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f1002" \
  -H "Authorization: Bearer nmo_live_REPLACE_WITH_YOUR_KEY"

Response 200

{
  "headline": "12 items need your review.",
  "signals": [
    {
      "id": "review_queue_depth",
      "severity": "attention",
      "sentence": "12 items are waiting in the review queue.",
      "action": "Review the queue.",
      "evidence": [
        {
          "label": "12 pending items",
          "url": "/app/review-queue"
        }
      ]
    }
  ]
}

Response fields

headline

Typestring

PresentAlways

signals

Typearray of object

PresentAlways

signals[].id

Typestring

PresentAlways

signals[].severity

Typestring

PresentAlways

Details

one of: blocking, urgent, attention, informational

signals[].sentence

Typestring

PresentAlways

signals[].action

Typestring

PresentAlways

signals[].evidence

Typearray of object

PresentAlways

signals[].evidence[].label

Typestring

PresentAlways

signals[].evidence[].url

Typestring

PresentSometimes

Field	Type	Present	Details
headline	string	Always
signals	array of object	Always
signals[].id	string	Always
signals[].severity	string	Always	one of: blocking, urgent, attention, informational
signals[].sentence	string	Always
signals[].action	string	Always
signals[].evidence	array of object	Always
signals[].evidence[].label	string	Always
signals[].evidence[].url	string	Sometimes

Errors

entity_not_allowed

Status403

MeaningYour key is limited to certain businesses, and this is not one of them.

not_found

Status404

MeaningThere is no such record, or none your key can reach.

Status	Code	Meaning
403	entity_not_allowed	Your key is limited to certain businesses, and this is not one of them.
404	not_found	There is no such record, or none your key can reach.

Every endpoint can also return:

invalid_key

Status401

MeaningYour key is missing, malformed, revoked, or expired.

insufficient_scope

Status403

MeaningYour key does not carry the scope this endpoint needs.

rate_limited

Status429

MeaningYou've made too many requests for this key. The retry-after header says how long to wait.

validation_failed

Status422

MeaningSomething in the path, the query, or the body did not pass validation.

internal_error

Status500

MeaningSomething went wrong on our side. Try again.

Status	Code	Meaning
401	invalid_key	Your key is missing, malformed, revoked, or expired.
403	insufficient_scope	Your key does not carry the scope this endpoint needs.
429	rate_limited	You've made too many requests for this key. The retry-after header says how long to wait.
422	validation_failed	Something in the path, the query, or the body did not pass validation.
500	internal_error	Something went wrong on our side. Try again.

Back to the API reference