GET/api/v1/get-role-limit

Get a role's limit

Returns the spending limit and reset cycle configured on one role in a workspace, along with the role's name.

AccessRequires a permission in the workspaceMANAGE_ROLE

A role limit caps what each member holding that role can move in a cycle, separately from the limit on the vault the value comes from. This call reports the policy as configured: Limit is the amount, CyclePeriod is W for weekly or M for monthly, and CycleDay is the day of the week or the day of the month the counter resets on. Roles are workspace-scoped, so pass the workspace the role belongs to: see Roles and permissions.

Usage is not part of this response. For what a single member has spent against the limit, read the member list with GET /api/v1/get-users-from-workspace, or, for your own figures, GET /api/v1/get-my-limits. To test one amount for one member, use GET /api/v1/check-user-role-limit; to change the policy, use POST /api/v1/update-role-policies.

Query parameters

role_idnumberrequired

The role whose limit to read, as returned in RoleUID by get-roles-and-perms-detailed.

workspace_idnumberrequired

The workspace the role belongs to. You must hold MANAGE_ROLE in it.

bash

curl "$SQRL_API/api/v1/get-role-limit?role_id=77&workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  role_id: "77",
  workspace_id: "342",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-role-limit?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { RoleName, Limit, CyclePeriod, CycleDay } = await res.json();

rust

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

Response200 OK

{
"RoleName": "Approver",
"Limit": "50000.00",
"CyclePeriod": "M",
"CycleDay": 1
}

Was this page helpful?