List or search teams
get/v1/teams/listThis API is used to list the teams. The team details like team name, users, created date, modified date, etc., will be fetched for all the listed teams.
Code snippet
curl -X 'GET' \
'https://api.boldsign.com/v1/teams/list?Page=1&PageSize=10' \
-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 teams = teamClient.ListTeam(1,10);
import boldsign
configuration = boldsign.Configuration(
api_key = "YOUR_API_KEY"
)
with boldsign.ApiClient(configuration) as api_client:
teams_api = boldsign.TeamsApi(api_client)
team_list_response = teams_api.list_teams(
page_size=10, page=1
)
const axios = require('axios');
const response = await axios.get('https://api.boldsign.com/v1/teams/list', {
params: {
'Page': '1',
'PageSize': '10'
},
headers: {
'accept': 'application/json',
'X-API-KEY': '<API-KEY>'
}
});
Query parameters
| Pageinteger | The page number (starting with 1) that you would like to view. |
| PageSizeinteger | The maximum number of Team objects per page is 10 by default. The value must be between 1 and 100. |
Example response
200 Success
{
"pageDetails": {
"pageSize": 10,
"page": 1
},
"results": [
{
"teamName": "HR",
"teamId": "b3ce652c-xxxx-xxxx-xxxx-0065369b4c92",
"createdDate": 1606106097,
"modifiedDate": 1606106097
},
]
}