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", "API-KEY");

var teamClient = new TeamClient(apiClient);

var teams = teamClient.ListTeam(1,10);
import requests
url = "https://api.boldsign.com/v1/teams/list?Page=1&PageSize=10"
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/list', { 
    params: { 
        'Page': '1', 
        'PageSize': '10' 
    }, 

    headers: { 
        'accept': 'application/json', 
        'X-API-KEY': '<API-KEY>' 
    } 
}); 

Query parameters

PageintegerThe page number (starting with 1) that you would like to view.
PageSizeintegerThe maximum number of Team objects in a page (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
    },
  ]
}