Your account, and the businesses inside it.

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

GET/businesses

Lists the businesses in your account that this key may use.

A key always belongs to exactly one account. Each id in businesses is what entityId takes elsewhere.
A key limited to particular businesses sees only those.

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

Request

curl "https://www.numm.io/api/v1/businesses" \
  -H "Authorization: Bearer nmo_live_REPLACE_WITH_YOUR_KEY"

Response 200

{
  "accountName": "Acme Bookkeeping",
  "businesses": [
    {
      "id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f1002",
      "name": "Acme Co"
    }
  ]
}

Response fields

accountName

Typestring

PresentAlways

businesses

Typearray of object

PresentAlways

businesses[].id

Typestring

PresentAlways

Details

a uuid

businesses[].name

Typestring

PresentAlways

Field	Type	Present	Details
accountName	string	Always
businesses	array of object	Always
businesses[].id	string	Always	a uuid
businesses[].name	string	Always

Errors

This call can 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