Manage members

Add people to your Organization with an email invitation, and give each one the Organization role that matches their work. Membership lets a person sign in, but it does not let them see any Project's data, so you also grant them a Project role.

PrerequisitesCopy Anchor Link

• You have the Organization owner role. Only owners can invite, list, and manage members.
• You signed in to the Organization that you manage. See Sign in.

Invite a memberCopy Anchor Link

Send an invitation to an email address. The invitation expires after seven days unless you set another value.

request = OrganizationInviteMemberRequest(email="teammate@example.com", role="member", expires_in_days=7)
invitation = client.organization.invite_member(request)
print(f"sent invitation {invitation.invitation_id}")

The role value is guest, member, or owner. See Organization roles.

The person becomes a member when they accept the invitation.

Manage pending invitationsCopy Anchor Link

List the Organization's invitations, then send one again or revoke it:

curl https://api.spiraldb.dev/v1/organizations/invitations \
  -H "Authorization: Bearer $SPIRAL_TOKEN"

curl -X POST https://api.spiraldb.dev/v1/organizations/invitations/$INVITE_ID/resend \
  -H "Authorization: Bearer $SPIRAL_TOKEN"

curl -X POST https://api.spiraldb.dev/v1/organizations/invitations/$INVITE_ID/revoke \
  -H "Authorization: Bearer $SPIRAL_TOKEN"

List membersCopy Anchor Link

for member in client.organization.list_members_items(page_size=50):
    print(f"{member.email} ({member.role}, {member.auth_method}) last signed in {member.last_sign_in_at}")

Change a roleCopy Anchor Link

Set a new Organization role for a member:

curl -X PUT https://api.spiraldb.dev/v1/organizations/users/$USER_ID/role \
  -H "Authorization: Bearer $SPIRAL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"role": "owner"}'

The API rejects a change that removes the last owner. Promote another member first.

Deactivate a memberCopy Anchor Link

Deactivate a member who leaves the team. Deactivation ends their sessions in the Organization and stops them from signing in to it again.

curl -X POST https://api.spiraldb.dev/v1/organizations/users/$USER_ID/deactivate \
  -H "Authorization: Bearer $SPIRAL_TOKEN"

Their Project grants stay in place. They cannot use them while they cannot sign in, but revoke them too if you want each Project's grant list to match who is actually on the team. See Revoke a grant.

TroubleshootingCopy Anchor Link

Where next: grant Project access to the new member.