GET/api/v1/get-pending-workspace-invites

List a workspace's outstanding invitations

Lists the invitations still waiting to be accepted or declined in a workspace, with the invited email address and the role each one offers.

AccessRequires a permission in the workspaceMANAGE_USERS

This is the administrator's view of the invitations sent with POST /api/v1/invite-to-workspace: everyone who has been invited to the workspace and has not yet responded. An invitation leaves the list once it has been accepted or declined, at which point an accepted member appears in GET /api/v1/get-users-from-workspace instead.

Each entry gives the InviteUID, the address the invitation went to, and the name of the role it offers. The member's own view of the same invitations, with the full role and permission detail, is GET /api/v1/get-invites-pending.

Query parameters

workspace_idnumberrequired

The workspace whose outstanding invitations to list. You must hold MANAGE_USERS in it.

bash

curl "$SQRL_API/api/v1/get-pending-workspace-invites?workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

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

rust

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

Response200 OK

{
"Invites": [
  {
    "InviteUID": 1204,
    "Email": "operator@example.com",
    "RoleName": "Approver"
  },
  {
    "InviteUID": 1211,
    "Email": "chi.nakamura@northgate.example",
    "RoleName": "Auditor"
  }
]
}

Was this page helpful?