Get details of a team
get/v1/teams/getThis 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 requests url = "https://api.boldsign.com/v1/teams/get?teamId=a5016cef-7bcd-4a60-b8bf-98fed2183b5c" payload={} headers = { 'accept': 'application/json', 'X-API-KEY': '<API-KEY>' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
const axios = require('axios'); const response = await axios.get('https://api.boldsign.com/v1/teams/get', { params: { 'teamId': 'a5016cef-7bcd-4a60-b8bf-98fed2183b5c' }, headers: { 'accept': 'application/json', 'X-API-KEY': '<API-KEY>' } });
Query parameters
teamIdstringRequired | The 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 }