Guides

Reference

Guides

Teams

Teams is a RESTful API that helps you manage the seats on your Typeform team. Use Teams to add and remove any Typeform user as a team member with access to your shared workspaces, without using the Typeform admin panel.

Key Concepts

Teams are multi-user plans that are managed by a PRO+ account holder. PRO+ account holders can invite anyone with a Typeform account to collaborate on typeforms in shared workspaces.

Each PRO+ account holder has one team. Each team comes with a specific number of "seats," depending on which PRO+ plan the account holder has.

With the Teams API, account holders can designate these seats to other people who they want to be able to access their shared workspaces.

Counting seats

Each team member you add to your team is one seat. Account holders also count as one seat. For example, if you have a PRO+5 account, and you add two people to your workspaces, you have filled three of your five seats (you plus your two teammates). With your PRO+5 account, you will have two more seats available on your team.

Walkthroughs

Figure out how many seats are available on your team

Suppose you want to add another Typeform user, Susanna, to your team, but you aren't sure whether you have an empty seat available. To figure out how many total seats you have and how many are occupied, send a GET https://api.typeform.com/teams/mine request.

The JSON response will include the total number of seats on your team, along with an array that lists the Typeform users who are currently occupying a seat on your team (the array will contain one object per team member).

Add a team member

Now, imagine that you have a PRO+3 account (three total seats) and two team members: you as the account holder and one other team member. You have the empty seat you need to add Susanna! Here's how to add her:

Confirm that you have the email address Susanna is using for her Typeform account. Let's assume it's susanna123@email.com.

Remove a team member

Suppose that Susanna moved to another role in your company, and you want to free up her seat on your Typeform team. To remove her, you'll use PATCH https://api.typeform.com/teams/mine again. However, this time you'll use the operator remove. Here's the request in cURL: