A member's effective quota

GET

/org/members/{userId}/quota

const url = 'https://api.asklucy.eu/v1/org/members/example/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.asklucy.eu/v1/org/members/example/quota \
  --header 'Authorization: Bearer <token>'

The limits that apply to this member right now, what they’ve spent, and which level each limit comes from.

Authorizations

zitadel

Parameters

Path Parameters

userId

required

string

Zitadel user ID.

Responses

200

application/json

Admin view of one member (amounts in money).

object

user

required

object

required

Zitadel user ID.

string

name

required

string

email

string | null format: email

kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string

Allowed values: person service agent

windows

required

Array<object>

object

window

required

string

Allowed values: five_hours week month

limit

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

spent

required

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

percent_used

number | null

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

source

required

Where this window’s limit comes from.

object

level

required

string

Allowed values: user_override group_override org_default none

group

One of:

object
null

object

required

string

name

required

string

source

required

Where the group and its members come from.

string

Allowed values: identity_provider

member_count

integer | null

org_monthly_remaining

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

Example

{
  "user": {
    "kind": "person"
  },
  "windows": [
    {
      "window": "five_hours",
      "limit": {
        "amount": "50.00",
        "currency": "EUR"
      },
      "spent": {
        "amount": "50.00",
        "currency": "EUR"
      },
      "source": {
        "level": "user_override",
        "group": {
          "source": "identity_provider"
        }
      }
    }
  ],
  "org_monthly_remaining": {
    "amount": "50.00",
    "currency": "EUR"
  }
}

401

Missing, expired or invalid token.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

403

The token is valid but lacks the role this needs.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

404

No such object in your organization.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.