GET/api/v1/get-invites-pending

List your pending invitations

Lists the workspace invitations currently waiting for the signed-in user, each with the organisation, the workspace, and the role and permissions it offers.

AccessRequires a signed-in caller

This is the call behind the invitations a member sees when they sign in. It takes no parameters: the list is scoped to whoever the bearer token belongs to. Each entry gives the workspace being offered along with its network, the organisation it sits in, and the role the member would hold, expanded to the individual permissions that role grants.

Respond to an entry with GET /api/v1/accept-invite, which identifies the invitation by Workspace.uid rather than by the InviteUID returned here. An administrator sees the same invitations from the workspace side with GET /api/v1/get-pending-workspace-invites.

bash

curl "$SQRL_API/api/v1/get-invites-pending" \
  -H "authorization: Bearer $SQRL_TOKEN"

const res = await fetch(
  `${process.env.SQRL_API}/api/v1/get-invites-pending`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { Invites } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/get-invites-pending", api_base))
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"Invites": [
  {
    "InviteUID": 1204,
    "Workspace": {
      "uid": 342,
      "name": "Treasury Operations",
      "description": "Live issuance and settlement",
      "net": "mainnet"
    },
    "Org": {
      "UID": 118,
      "Name": "Northgate Treasury"
    },
    "Role": {
      "Role": {
        "RoleUID": 77,
        "Name": "Approver",
        "Description": "Reviews and signs pending movements"
      },
      "RulesList": {
        "Rules": [
          { "UID": 6, "RuleName": "PAYMENT_APPROVE" },
          { "UID": 8, "RuleName": "VIEW_BALANCES" }
        ]
      }
    }
  },
  {
    "InviteUID": 1211,
    "Workspace": {
      "uid": 355,
      "name": "Treasury Sandbox",
      "description": "Supervised training and pre-production testing",
      "net": "testnet"
    },
    "Org": {
      "UID": 118,
      "Name": "Northgate Treasury"
    },
    "Role": {
      "Role": {
        "RoleUID": 78,
        "Name": "Auditor",
        "Description": "Read-only review of balances"
      },
      "RulesList": {
        "Rules": [
          { "UID": 8, "RuleName": "VIEW_BALANCES" }
        ]
      }
    }
  }
]
}

Was this page helpful?