Get the caller's organization quota

GET

/v1/me/org-quota

const url = 'https://api.overwatch.weareheavy.dev/v1/me/org-quota';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.overwatch.weareheavy.dev/v1/me/org-quota \
  --header 'Authorization: Bearer <token>'

How many organizations the caller belongs to versus their cap, so a dashboard can show a “limit reached” state before an attempted create. Session-only.

Authorizations

BearerAuth

Responses

200

The caller’s organization quota.

application/json

object

count

required

integer

max

required

integer

canCreate

required

Whether creating another organization would be allowed.

boolean

latestRequest

required

One of:

object
null

A compact view of the latest limit-increase request.

object

required

string format: uuid

requestedLimit

required

integer

status

required

string

Allowed values: pending approved rejected

decisionNote

required

The operator’s note on the decision, if any.

string | null

createdAt

required

Epoch ms.

integer

Example

{
  "latestRequest": {
    "status": "pending"
  }
}

401

Missing or invalid credentials.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "invalid api key"
}

403

A dashboard session is required (API-key callers are rejected), or the session’s role does not allow this action.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "a dashboard session is required"
}