Get details of a team

get/v1/teams/get

This API is used to fetch the details of the team. Team details like team name, users, created date, modified date, etc., can be retrieved.

Code snippet

curl -X 'GET' \
  'https://api.boldsign.com/v1/teams/get?teamId=a5016cef-7bcd-4a60-b8bf-98fed2183b5c' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "API-KEY");

var teamClient = new TeamClient(apiClient);

var teamDetails = teamClient.GetTeamDetails("a5016cef-7bcd-4a60-b8bf-98fed2183b5c");
import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    teams_api = boldsign.TeamsApi(api_client)
    team_details_response = teams_api.get_team(team_id="YOUR_TEAM_ID")
<?php require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$teams_api = new BoldSign\Api\TeamsApi($config);
$team_details_response = $teams_api->getTeam($team_id = 'YOUR_TEAM_ID');
ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
            
TeamsApi teamsApi = new TeamsApi(client);
TeamResponse teamDetailsResponse = teamsApi.getTeam("YOUR_TEAM_ID");
import { TeamsApi} from "@boldsign/node-sdk";

const teamsApi = new TeamsApi();
teamsApi.setApiKey("YOUR_API_KEY");

const teamDetailsResponse = teamsApi.getTeam("YOUR_TEAM_ID");

Query parameters

teamIdstringRequiredThe ID of the team to retrieve.

Example response

200 Success

{
  "teamId": "a5016cef-xxxx-xxxx-xxxx-98fed2183b5c",
  "teamName": "HR",
  "users": [
    {
      "userId": "04029917-xxxx-xxxx-xxxx-33835939d021",
      "email": "alexgayle@cubeflakes.com",
      "firstName": "Alex Gayle",
      "lastName": "k",
      "userRole": "TeamAdmin",
      "userStatus": "Active"
    }
  ],
  "createdDate": 1635942532,
  "modifiedDate": 1635942532
}