get-organization-members
Retrieve organization member lists with filtering options for roles, licenses, and status to manage team access and permissions in Miro.
Instructions
Retrieves a list of members for an organization (Enterprise only)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orgId | Yes | id of the organization | |
| emails | No | Filter by comma-separated email addresses | |
| role | No | Filter by user role | |
| license | No | Filter by license type | |
| active | No | Filter by active status | |
| cursor | No | Cursor for pagination | |
| limit | No | Maximum number of results to return |
Implementation Reference
- The handler function that implements the tool logic: constructs query parameters from inputs and calls the Miro API to get organization members.
fn: async ({ orgId, emails, role, license, active, cursor, limit }) => { try { const query: any = {}; if (emails) query.emails = emails; if (role) query.role = role; if (license) query.license = license; if (active !== undefined) query.active = active; if (cursor) query.cursor = cursor; if (limit) query.limit = limit; const response = await MiroClient.getApi().enterpriseGetOrganizationMembers(orgId, query); return ServerResponse.text(JSON.stringify(response.body, null, 2)); } catch (error) { process.stderr.write(`Error retrieving organization members: ${error}\n`); return ServerResponse.error(error); } } - Input schema using Zod for validating tool parameters like orgId, filters, and pagination.
args: { orgId: z.string().describe("id of the organization"), emails: z.string().optional().nullish().describe("Filter by comma-separated email addresses"), role: z.enum(['organization_internal_admin', 'organization_internal_user', 'organization_external_user', 'organization_team_guest_user', 'unknown']).optional().nullish().describe("Filter by user role"), license: z.enum(['full', 'occasional', 'free', 'free_restricted', 'full_trial', 'unknown']).optional().nullish().describe("Filter by license type"), active: z.boolean().optional().nullish().describe("Filter by active status"), cursor: z.string().optional().nullish().describe("Cursor for pagination"), limit: z.number().optional().nullish().describe("Maximum number of results to return") }, - src/index.ts:197-197 (registration)Registers the getOrganizationMembersTool with the ToolBootstrapper instance.
.register(getOrganizationMembersTool)