list_teams
Fetch a paginated list of teams in your BoldSign organization, including team names, users, and creation details. Filter results with a search term and navigate through pages for efficient team management.
Instructions
Retrieve a paginated list of teams within your BoldSign organization. This API fetches team details such as team name, users, created date, and modified date for all listed teams, with options for filtering using a search term and navigating through pages of results.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Required. The page number to retrieve from the list of teams, starting from 1. Used for pagination to navigate through the list of available teams. | |
| pageSize | No | Optional. Specifies the maximum number of teams to retrieve per page. The value must be an integer between 1 and 100. By default, the BoldSign API retrieves 10 teams per page. | |
| searchKey | No | Optional. A search term to filter the list of teams. The API will return teams whose details, such as name, match the provided search term. |
Implementation Reference
- src/tools/teamsTools/listTeams.ts:30-46 (handler)The main handler function that initializes the TeamsApi client, calls listTeams with pagination and search parameters, and returns the formatted response or handles errors.async function listTeamsHandler(payload: ListTeamsSchemaType): Promise<McpResponse> { try { const teamsApi = new TeamsApi(); teamsApi.basePath = configuration.getBasePath(); teamsApi.setApiKey(configuration.getApiKey()); const teamListResponse: TeamListResponse = await teamsApi.listTeams( payload.page, payload.pageSize ?? undefined, payload.searchKey ?? undefined, ); return handleMcpResponse({ data: teamListResponse, }); } catch (error: any) { return handleMcpError(error); } }
- Zod input schema defining pageSize (1-100), page (default 1), and optional searchKey.const ListTeamsSchema = z.object({ pageSize: z.number().int().min(1).max(100), page: z.number().int().min(1).default(1), searchKey: commonSchema.OptionalStringSchema.describe( 'Optional. A search term to filter the list of teams. The API will return teams whose details, such as name, match the provided search term.', ), });
- src/tools/teamsTools/listTeams.ts:19-28 (registration)Tool definition including method name 'list_teams', description, input schema, and handler wrapper.export const listTeamsToolDefinition: BoldSignTool = { method: ToolNames.ListTeams.toString(), name: 'List teams', description: 'Retrieve a paginated list of teams within your BoldSign organization. This API fetches team details such as team name, users, created date, and modified date for all listed teams, with options for filtering using a search term and navigating through pages of results.', inputSchema: ListTeamsSchema, async handler(args: unknown): Promise<McpResponse> { return await listTeamsHandler(args as ListTeamsSchemaType); }, };
- src/tools/teamsTools/index.ts:5-5 (registration)Registers listTeamsToolDefinition in the teams API tools array.export const teamsApiToolsDefinitions: BoldSignTool[] = [getTeamToolDefinition, listTeamsToolDefinition];
- src/tools/index.ts:13-13 (registration)Spreads teams API tools (including list_teams) into the global tools definitions array....teamsApiToolsDefinitions,