get_team
Retrieve detailed information about an existing team in your BoldSign organization, including team name, users, and creation date, by specifying the unique team ID.
Instructions
Retrieve detailed information about an existing team in your BoldSign organization. This API provides access to team-specific properties, such as team name, users, created date, and modified date, by specifying the unique team ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| teamId | Yes | Required. The unique identifier (ID) of the team to retrieve. This can be obtained from the list teams tool. |
Implementation Reference
- src/tools/teamsTools/getTeam.ts:28-40 (handler)Executes the core logic of the get_team tool by initializing the BoldSign TeamsApi client with configuration, fetching the team details using the provided teamId, and returning the formatted MCP response or handling errors.
async function getTeamHandler(payload: GetTeamSchemaType): Promise<McpResponse> { try { const teamsApi = new TeamsApi(); teamsApi.basePath = configuration.getBasePath(); teamsApi.setApiKey(configuration.getApiKey()); const teamResponse: TeamResponse = await teamsApi.getTeam(payload.teamId); return handleMcpResponse({ data: teamResponse, }); } catch (error: any) { return handleMcpError(error); } } - src/tools/teamsTools/getTeam.ts:9-13 (schema)Zod input schema for the get_team tool, validating the required teamId parameter.
const GetTeamSchema = z.object({ teamId: commonSchema.InputIdSchema.describe( 'Required. The unique identifier (ID) of the team to retrieve. This can be obtained from the list teams tool.', ), }); - src/tools/teamsTools/getTeam.ts:17-26 (registration)Registers the get_team tool definition, specifying its method name ('get_team'), description, input schema, and handler function.
export const getTeamToolDefinition: BoldSignTool = { method: ToolNames.GetTeam.toString(), name: 'Get team', description: 'Retrieve detailed information about an existing team in your BoldSign organization. This API provides access to team-specific properties, such as team name, users, created date, and modified date, by specifying the unique team ID.', inputSchema: GetTeamSchema, async handler(args: unknown): Promise<McpResponse> { return await getTeamHandler(args as GetTeamSchemaType); }, }; - src/tools/teamsTools/index.ts:5-5 (registration)Includes the get_team tool in the array of teams API tool definitions, which is later aggregated at higher levels.
export const teamsApiToolsDefinitions: BoldSignTool[] = [getTeamToolDefinition, listTeamsToolDefinition]; - src/tools/index.ts:8-14 (registration)Top-level aggregation of all tool definitions, including teamsApiToolsDefinitions which contains get_team.
export const definitions: BoldSignTool[] = [ ...contactsApiToolsDefinitions, ...documentsApiToolsDefinitions, ...templatesApiToolsDefinitions, ...usersApiToolsDefinitions, ...teamsApiToolsDefinitions, ];