Organization

Which account and environment a key belongs to, what it may do, its rate limit and the account currency. Needs no scope, so it is the first call to make.

No scope neededhttps://public-api.nutrasoft.ca/v1

The Organization object

api_key_idinteger
Quote this alongside a request id in support.
companystringnullable
The account name, as configured in NutraSoft.
currencystring
ISO 4217 code of the account's currency, which every money field is in.
environmentstring
Derived from the account, never from the key.
- one oflivetest
key_prefixstring
The visible start of the key, so you can tell which one is in use.
license_idinteger
The account this key belongs to.
rate_limit_per_mininteger
Requests per minute, counted per account rather than per key.
scopesarray of string
The effective scopes: a write scope also lists its read scope, so sales:write reports both sales:write and sales:read.

Operations

Who this key is

get/organizationno scope needed

The account the key belongs to, its environment and currency, and what the key may do. Needs no scope beyond a valid key.

Returns

200 One Organization object in data.

Errors

400 401 403 429 500 503

GET /organization

curl "https://public-api.nutrasoft.ca/v1/organization" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": {
    "api_key_id": 123,
    "company": "Example Foods Inc.",
    "currency": "CAD",
    "environment": "test",
    "key_prefix": "nsk_test_9fA",
    "license_id": 123,
    "rate_limit_per_min": 300,
    "scopes": [
      "catalog:read",
      "sales:read",
      "sales:write"
    ]
  }
}