List or search teams

get/v1/teams/list

This 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", "Your_API_Key");

var teamClient = new TeamClient(apiClient);

var teamList = teamClient.ListTeam(1);

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 = teams_api.list_teams(page=1)

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\TeamsApi;

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

$teams_api = new TeamsApi($config);
$team_list = $teams_api->listTeams($page = 1);

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
           
TeamsApi teamsApi = new TeamsApi(client);

int page = 1;
TeamListResponse teamList = teamsApi.listTeams(page, null, null);

import { TeamsApi } from "boldsign";

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

const teamList = teamsApi.listTeams(1);

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
    },
  ]
}