GET/api/v1/get-my-limits

Get your own limits

Returns the spending limit that applies to the caller in one workspace, how much they have already spent in the current cycle, and when the counter resets.

AccessRequires a permission in the workspacePAYMENT_INIT

Call this before starting a movement to see what headroom you have. The limit comes from the role you hold in the workspace you name, and amount_spent is your own usage in the current cycle, so the difference between the two is what you can still move before the counter resets. Because roles are workspace-scoped, the answer applies to that workspace only: see Roles and permissions.

Every field except role_name can be null, which means no spending policy is set for your role. These are plain JSON nulls, not the nullable wrapper used elsewhere in the API. cycle_period is W for a weekly cycle or M for a monthly one, and cycle_day is the day of the week or the day of the month the counter resets on. Your role limit is not the only constraint on a movement: the vault it comes from has a limit of its own, described under Vault policies.

Query parameters

workspace_idnumberrequired

The workspace to report your limit in. Your role, and therefore your limit, can differ in each workspace.

bash

curl "$SQRL_API/api/v1/get-my-limits?workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({ workspace_id: "342" });
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-my-limits?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { role_name, role_limit, amount_spent } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/get-my-limits", api_base))
    .query(&[("workspace_id", "342")])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"role_name": "Approver",
"role_limit": "50000.00",
"amount_spent": "12250.75",
"cycle_period": "M",
"cycle_day": 1
}

Was this page helpful?