Platform

Organizations

Create and manage organizations for team collaboration. Invite members, manage roles, and share proxy keys.

Create Organization

POST/v1/organizations

Body Parameters

namestringrequired

Organization display name

cURL
curl -X POST https://api.metriqual.com/v1/organizations \
  -H "Authorization: Bearer YOUR_JWT" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Company"}'
TypeScript SDK
const org = await mql.organizations.create({
  display_name: 'My Company'
});
console.log(org.id, org.display_name);
Python SDK
org = mql.organizations.create(display_name="My Company")
print(org["id"], org["display_name"])
CLI
mql orgs create -n "my-company" -d "My Company"

List Organizations

GET/v1/organizations

List all organizations the authenticated user belongs to.

TypeScript SDK
const { organizations } = await mql.organizations.list();
organizations.forEach(o => console.log(o.display_name, o.role));
Python SDK
result = mql.organizations.list()
for o in result["organizations"]:
    print(o["display_name"], o["role"])
CLI
mql orgs list
mql orgs ls --json

Get Organization

GET/v1/organizations/:org_id

Get detailed information about a specific organization.

TypeScript SDK
const org = await mql.organizations.get('org_id');
console.log(org.display_name, org.member_count);
Python SDK
org = mql.organizations.get("org_id")
print(org["display_name"], org["member_count"])
CLI
mql orgs get ORG_ID
mql orgs dashboard ORG_ID

Members

GET/v1/organizations/:org_id/members
DELETE/v1/organizations/:org_id/members/:member_id
PATCH/v1/organizations/:org_id/members/:member_id/role
TypeScript SDK
// List members
const members = await mql.organizations.listMembers('org_id');
members.forEach(m => console.log(m.email, m.role));

// Update role
await mql.organizations.updateMemberRole('org_id', 'user_id', {
  role: 'admin'
});

// Remove member
await mql.organizations.removeMember('org_id', 'user_id');
CLI
mql orgs members ORG_ID
mql orgs update-role ORG_ID --user USER_ID --role admin
mql orgs remove-member ORG_ID --user USER_ID
Python SDK
# List members
members = mql.organizations.list_members("org_id")
for m in members:
    print(m["email"], m["role"])

# Update role
mql.organizations.update_member_role("org_id", "user_id", role="admin")

# Remove member
mql.organizations.remove_member("org_id", "user_id")

Invitations

POST/v1/organizations/:org_id/invites
GET/v1/organizations/:org_id/invites
DELETE/v1/organizations/:org_id/invites/:invite_id
POST/v1/organizations/:org_id/invites/:invite_id/resend
GET/v1/invites/pending
POST/v1/invites/accept
TypeScript SDK
// Invite member
const invite = await mql.organizations.inviteMember('org_id', {
  email: 'teammate@company.com',
  role: 'member'
});

// List pending invites
const invites = await mql.organizations.listInvites('org_id');

// Cancel invite
await mql.organizations.cancelInvite('org_id', 'invite_id');

// Resend invite
await mql.organizations.resendInvite('org_id', 'invite_id');

// View my pending invites
const myInvites = await mql.organizations.getMyInvites();

// Accept invite
await mql.organizations.acceptInvite({ invite_id: 'inv_...' });
Python SDK
# Invite member
invite = mql.organizations.invite_member(
    "org_id", email="teammate@company.com", role="member"
)

# List invites for org
invites = mql.organizations.list_invites("org_id")

# Cancel invite
mql.organizations.cancel_invite("org_id", "invite_id")

# Resend invite
mql.organizations.resend_invite("org_id", "invite_id")

# View my pending invites
my_invites = mql.organizations.get_my_invites()

# Accept invite
mql.organizations.accept_invite(invite_id="inv_...")
CLI
mql orgs invite ORG_ID -e teammate@company.com -r member
mql orgs invites ORG_ID
mql orgs cancel-invite ORG_ID --invite INVITE_ID

SDK & CLI Reference

OperationTypeScriptPythonCLI
Listmql.organizations.list()mql.organizations.list()mql orgs list
Getmql.organizations.get(id)mql.organizations.get(id)mql orgs get ID
Createmql.organizations.create(req)mql.organizations.create(...)mql orgs create
List membersmql.organizations.listMembers(org)mql.organizations.list_members(org)mql orgs members ID
Invitemql.organizations.inviteMember(org, req)mql.organizations.invite_member(org, ...)mql orgs invite ID
Remove membermql.organizations.removeMember(org, uid)mql.organizations.remove_member(org, uid)mql orgs remove-member
Update rolemql.organizations.updateMemberRole(...)mql.organizations.update_member_role(...)mql orgs update-role
My invitesmql.organizations.getMyInvites()mql.organizations.get_my_invites()—
Accept invitemql.organizations.acceptInvite(req)mql.organizations.accept_invite(...)—