Team

Represents a team in your Fivetran account. Teams group users together and can be granted roles on connections, groups, and the account. Managing teams through the API lets you control access to resources without modifying individual user permissions.

Resource attributes

The following attributes describe a team and the membership records associated with it.

Team attributes

Field name	Type	Description
`id`	string, read-only	Unique identifier of the team.
`name`	string	Name of the team.
`description`	string	Description of the team.
`role`	string	Account-level role assigned to the team. For available role names, call `GET /v1/roles` and filter results where `scope` includes `ACCOUNT`.

Membership attributes

These attributes describe a team's membership in a connection or group, or a user's membership in a team.

Field name	Type	Description
`id`	string, read-only	Unique identifier of the connection or group the team has membership in. For user memberships, this field is named `user_id`.
`role`	string	Role assigned within the connection, group, or team. For available role names, call `GET /v1/roles` and filter by `scope`.
`created_at`	string, read-only	Date and time the membership was created, in ISO 8601 format.

Supported operations

Category	Endpoint	Description
List	`GET /v1/teams`	Returns a paginated list of all teams in the account.
Create	`POST /v1/teams`	Creates a new team.
Retrieve	`GET /v1/teams/{teamId}`	Returns the details of a team.
Update	`PATCH /v1/teams/{teamId}`	Updates an existing team's name, description, or role.
Delete	`DELETE /v1/teams/{teamId}`	Deletes a team.
Remove account role	`DELETE /v1/teams/{teamId}/role`	Removes the team's account-level role.
List connection memberships	`GET /v1/teams/{teamId}/connections`	Returns all connections the team has membership in.
Manage connection membership	`GET /v1/teams/{teamId}/connections/{connectionId}` `POST /v1/teams/{teamId}/connections/{connectionId}` `PATCH /v1/teams/{teamId}/connections/{connectionId}` `DELETE /v1/teams/{teamId}/connections/{connectionId}`	Retrieve, add, update, or remove a team's membership in a connection.
List group memberships	`GET /v1/teams/{teamId}/groups`	Returns all groups the team has membership in.
Manage group membership	`GET /v1/teams/{teamId}/groups/{groupId}` `POST /v1/teams/{teamId}/groups/{groupId}` `PATCH /v1/teams/{teamId}/groups/{groupId}` `DELETE /v1/teams/{teamId}/groups/{groupId}`	Retrieve, add, update, or remove a team's membership in a group.
List user memberships	`GET /v1/teams/{teamId}/users`	Returns all users and their roles in the team.
Manage user membership	`GET /v1/teams/{teamId}/users/{userId}` `POST /v1/teams/{teamId}/users` `PATCH /v1/teams/{teamId}/users/{userId}` `DELETE /v1/teams/{teamId}/users/{userId}`	Retrieve, add, update, or remove a user's membership in the team.