Skip to content
  1. Blog
  2. API

BoldSign Teams API: Create, Rename, Get and List Teams for Contract Collaboration

TL;DR: A team in BoldSign is a group of users, such as HR or Legal, that shares its own templates and documents. The Teams API lets your code create, rename, look up and list those teams. Our eSignature API page shows what else you can automate.

Your company now has four departments sending contracts.

HR sends offer letters, Sales sends order forms, and Legal keeps its own templates. Setting up each group by hand works at first. It slows down when new departments or customer accounts appear every week.

This guide explains what teams do, then shows the four Teams API calls with code samples. For moving people between teams, see our guide to the ChangeTeam API.

What are BoldSign teams?

A team is a group of users inside your BoldSign organization. Think of it as a shared folder with a name on the door: everyone in HR works from the HR shelf.

In the web app, the account admin creates, renames, deletes and searches teams from Users & Teams. A team admin can do the same only inside their own team, as our help article on creating and managing teams explains. The Teams API gives your code the create, rename, look-up and list actions.

How do teams help contract collaboration?

Teams give each department its own space for shared templates and sent documents. You manage access once per team, not once per person.

  • You can share a template with another team with “Can use” or “Can edit” access.
  • Admins see each team’s document list and details (team or account admin view).
  • The account owner decides whether admins may also view and download document contents.
  • New hires inherit their team’s shared templates, so you skip per-person setup.

When does team management matter most?

Team management matters most when several groups send different documents from one account. Software that gives each customer its own workspace needs it too.

Typical cases:

  • HR offers, Legal contracts and Sales agreements come from separate departments.
  • A sensitive template must stay inside one group.
  • Admins must review the team structure for an audit.

What do you need before calling the Teams API?

You need a BoldSign account, a way to authenticate, and a tool to send requests. A free API sandbox account is enough to follow every example here.

  • An API key or an OAuth 2.0 access token.
  • A command line, Postman or one of our software development kits (SDKs).
  • TeamName to create a team, and TeamId to rename or look one up.

Send an API key in the X-API-KEY header. Send an OAuth token as Authorization: Bearer <access_token>. The examples below use an API key.

Which endpoints create, rename, get and list teams?

Four endpoints on https://api.boldsign.com cover the work. Each section below shows one of them in six languages.

Task Method and path Inputs What you get back
Create a team POST /v1/teams/create TeamName (required) The new teamId
Rename a team PUT /v1/teams/update TeamId and TeamName (both required) A 200 success status
Get team details GET /v1/teams/get teamId (query, required) Name, users, created and modified dates
List teams GET /v1/teams/list page, pageSize A paged list of teams

How do you create a team with the BoldSign API?

Send a create request with the team’s name in the body. The response holds the new team ID, which you store for later calls.

TeamName is the required body field, a string such as “HR”. Our Create Team API documentation lists the full request and response.

curl -X 'POST' \
  'https://api.boldsign.com/v1/teams/create' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -d '{
  "TeamName": "HR"
}'
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var teamClient = new TeamClient(apiClient);
var team = new CreateTeam()
{
    TeamName = "HR"
};
var teamCreated = teamClient.CreateTeam(team);
import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
    teams_api = boldsign.TeamsApi(api_client)
    create_team_request = boldsign.CreateTeamRequest(teamName="HR")
    team_created = teams_api.create_team(create_team_request=create_team_request)
<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\TeamsApi;
use BoldSign\Model\CreateTeamRequest;

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

$teams_api = new TeamsApi($config);

$create_team_request = new CreateTeamRequest();
$create_team_request->setTeamName('HR');

$team_created = $teams_api->createTeam($create_team_request);
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");

TeamsApi teamsApi = new TeamsApi(client);

CreateTeamRequest createTeamRequest = new CreateTeamRequest();
createTeamRequest.setTeamName("HR");

TeamCreated teamCreated = teamsApi.createTeam(createTeamRequest);
import { CreateTeamRequest, TeamsApi } from "boldsign";

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

const createTeamRequest = new CreateTeamRequest();
createTeamRequest.teamName = "HR";

const teamCreated = teamsApi.createTeam(createTeamRequest);

How do you rename a team?

Send an update request with the team ID and the new name. The ID stays the same, so stored references keep working.

Both TeamId and TeamName are required. Our Update Team API documentation has the details.

curl -X 'PUT' \
  'https://api.boldsign.com/v1/teams/update' \
  -H 'accept: */*' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -d '{
  "TeamId": "8b637de3-27db-4603-a7d7-6a4fdd0124b8",
  "TeamName": "Sales"
}'
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var teamClient = new TeamClient(apiClient);
var team = new UpdateTeam()
{
    TeamName = "Sales",
    TeamId = "YOUR_TEAM_ID"
};
teamClient.UpdateTeam(team);
import boldsign
configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
    teams_api = boldsign.TeamsApi(api_client)
    team_update_request = boldsign.TeamUpdateRequest(teamId="YOUR_TEAM_ID", teamName="Sales")
    teams_api.update_team(team_update_request=team_update_request)
<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\TeamsApi;
use BoldSign\Model\TeamUpdateRequest;

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

$teams_api = new TeamsApi($config);

$team_update_request = new TeamUpdateRequest();
$team_update_request->setTeamName('Sales');
$team_update_request->setTeamId('YOUR_TEAM_ID');
$teams_api->updateTeam($team_update_request);
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");

TeamsApi teamsApi = new TeamsApi(client);

TeamUpdateRequest teamUpdateRequest = new TeamUpdateRequest();
teamUpdateRequest.setTeamId("YOUR_TEAM_ID");
teamUpdateRequest.setTeamName("Sales");

teamsApi.updateTeam(teamUpdateRequest);
import { TeamsApi, TeamUpdateRequest } from "boldsign";

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

const teamUpdateRequest = new TeamUpdateRequest();
teamUpdateRequest.teamId = "YOUR_TEAM_ID";
teamUpdateRequest.teamName = "Sales";

teamsApi.updateTeam(teamUpdateRequest);

How do you get team details and members?

Request the team by its ID, passed as a query parameter. The response lists the team name, its users and its created and modified dates.

Each user entry carries a user ID, email, first and last name, role (such as TeamAdmin) and status. Use this call to check a team before an audit or a report. Our Get Team API documentation shows a full response.

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", "Your_API_Key");
var teamClient = new TeamClient(apiClient);
var teamDetails = teamClient.GetTeamDetails("YOUR_TEAM_ID");
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 = teams_api.get_team(team_id="YOUR_TEAM_ID")
<?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_details = $teams_api->getTeam($team_id = 'YOUR_TEAM_ID');
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");

TeamsApi teamsApi = new TeamsApi(client);
TeamResponse teamDetails = teamsApi.getTeam("YOUR_TEAM_ID");
import { TeamsApi } from "boldsign";

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

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

How do you list or search teams?

Call the list endpoint with a page number and page size. It returns 10 teams per page by default.

Each result holds the team name, team ID, created date and modified date. Our List Teams documentation covers every field.

Two documented parameters control paging. The samples below also pass a search term.

Parameter What it does Notes
page The page number to fetch Starts at 1
pageSize Teams per page Default 10, from 1 to 100
searchKey A search term to narrow the list The samples search for “sales”
curl -X 'GET' \
  'https://api.boldsign.com/v1/teams/list?page=1&pageSize=10&searchKey=sales' \
  -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,10,"sales");
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, page_size=10, search_key="sales")
<?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,$page_Size=10,$search_key='sales');
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");

TeamsApi teamsApi = new TeamsApi(client);

int page = 1;
TeamListResponse teamList = teamsApi.listTeams(1, 10, "sales");
import { TeamsApi } from "boldsign";

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

const teamList = teamsApi.listTeams(1, 10, "sales");

How do teams fit into real workflows?

Two patterns come up often. Both rely on storing the team ID your code gets back.

Create a team for each department

Create HR, Sales, Legal and Finance teams when you set up an account. Each department then gets its own shared templates and its own document list.

Rename a team when your company changes

Sales becomes Business Development? Call the update endpoint with the same team ID. Your integrations keep working, because nothing points at the old name.

Moving people is the next step after a reorganization. Our ChangeTeam API guide shows how to move a user and hand over their documents. For adding and managing users themselves, see our user management API guide.

Which plan do you need, and what does it cost?

You can call every Teams endpoint for free in a sandbox account. Live API calls need our Enterprise API plan.

The Enterprise API plan starts at $30 a month with 40 envelopes, as listed on the BoldSign pricing page in November 2026. Each extra envelope costs $0.75, and prices are in USD. The plan includes two users, and each extra user costs $28.

How do you start managing teams with our API?

Run the create call in a sandbox first, then build list and rename into your admin screens. Add paging and error handling before you go live.

Frequently asked questions

What is a team in BoldSign?

A team is a group of users inside one BoldSign organization, such as HR or Sales. You share templates with a team and review each team's documents from one place.

Which BoldSign API endpoints manage teams?

Four endpoints under /v1/teams cover the basics: create, update, get and list. Each one takes your API key or OAuth token in the request header.

Can I authenticate the Teams API with OAuth instead of an API key?

Yes. You can send an OAuth 2.0 access token as a Bearer token instead of an API key. Server-to-server jobs usually keep an API key.

Does renaming a team change its team ID?

No. The team ID stays the same after a rename, so any code that stores the ID keeps working.

How many teams does the list endpoint return per page?

It returns 10 teams per page by default. You can set pageSize anywhere from 1 to 100 and step through pages with the page parameter.

Can a team admin open every document in the team?

Not by default. Admins see the document list and its details, and the account owner can grant a custom permission to view and download document contents.

How do I move a user from one team to another with the API?

Call the ChangeTeam endpoint with the user's ID and the new team ID. Our guide on moving users between teams walks through the request and its document options.

Can I try the Teams API for free?

Yes. A free sandbox account lets you call every Teams endpoint with test data. Live calls need a paid API plan.

Ranjitha Vazhivittan

Ranjitha is a skilled software developer with 3 years of experience at BoldSign. Alongside her technical expertise, she has a passion for writing and enjoys sharing thoughtful insights on technology and development. Beyond work, she stays curious by exploring emerging tools and trends, constantly seeking opportunities to learn and grow.

More posts by Ranjitha Vazhivittan
Get started

Sign up for your free trial today!

Start free trial
  • 30-day free trial
  • No credit card required