Team Managementlink
Our REST API supports the following team management actions:
- List all teams
- Retrieve team details
- Create a team
- Modify a team
- Delete a team role in the account
- Delete a team
User membershipslink
- List all user memberships
- Retrieve user membership
- Add a user to a team
- Modify a user membership
- Delete a user from a team
Connector membershipslink
- List all connector memberships
- Retrieve connector membership
- Add connector membership
- Update connector membership
- Delete connector membership
Group membershipslink
- List all group memberships
- Retrieve group membership
- Add group membership
- Update group membership
- Delete group membership
List all teamslink
Returns a list of all teams within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/teams
Query parameterslink
Name | Description |
---|---|
cursor | paging cursor, read more about pagination |
limit | number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items":[
{
"id": "abode_abolish",
"name": "Head Team",
"description": "Head Team description",
"role": "Account Administrator"
},
{
"id": "numerator_handiness",
"name": "Finance Team",
"description": "Finance Team description",
"role": "Account Reviewer"
}],
"next_cursor": "eyJza2lwIjoxfQ"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
items | The collection of teams |
item.id | The unique identifier for the team within your account. |
item.name | The name of the team within your account. |
item.description | The description of the team within your account. |
item.role | The account role of the team. |
next_cursor | The value of the cursor parameter for the next page |
Retrieve team detailslink
Returns information for a given team within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/teams/{team_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "abode_abolish",
"name": "Head Team",
"description": "Head Team description",
"role": "Account Reviewer"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data.id | The unique identifier for the team within your account. |
data.name | The name of the team within your account. |
data.description | The description of the team within your account. |
data.role | The account role of the team. |
Create a teamlink
Creates a new team in your Fivetran account.
Requestlink
POST https://api.fivetran.com/v1/teams
{
"name": "Finance Team",
"description": "Finance Team description",
"role": "Account Analyst"
}
Payload parameterslink
Name | Description |
---|---|
name (required) | The unique team name within the account. |
description (optional) | The description of the team within the account. |
role (required) | The team role within the account. Possible values: Account Administrator , Account Billing , Account Analyst , Account Reviewer , Destination Creator , or a custom role with account level permissions. |
Responselink
HTTP 201 CREATED
{
"code": "Success",
"message": "Team has been created",
"data": {
"id": "clarification_expand",
"name": "Finance Team",
"description": "Finance Team description",
"role": "Account Analyst"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data.id | The unique identifier of the created team within your account. |
data.name | The name of the created team within your account. |
data.description | The description of the created team within your account. |
data.role | The account role of the created team. |
Modify a teamlink
Updates information for an existing team within your Fivetran account.
Requestlink
PATCH https://api.fivetran.com/v1/teams/{team_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
{
"name": "Finance Team",
"description": "Finance Team description",
"role": "Account Analyst"
}
Payload parameterslink
Name | Description |
---|---|
name (optional) | The team name within the account. The name must be unique. |
description (optional) | The description of the team within the account. |
role (required) | The team role within the account. Possible values: Account Administrator , Account Billing , Account Analyst , Account Reviewer , Destination Creator , or a custom role with account level permissions. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Team has been updated",
"data": {
"id": "clarification_expand",
"name": "Finance Team",
"description": "Finance Team description",
"role": "Destination Analyst"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
data.id | The unique identifier of the team within your account. |
data.name | The name of the updated team within your account. |
data.description | The description of the created team within your account. |
data.role | The account role of the updated team. |
Delete team role in accountlink
Removes a team role within your Fivetran account.
Requestlink
DELETE https://api.fivetran.com/v1/teams/{team_id}/role
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Team role in account has been removed"
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
Delete a teamlink
Deletes a team from your Fivetran account.
Requestlink
DELETE https://api.fivetran.com/v1/teams/{team_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Team has been deleted"
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
List all user membershipslink
Returns a list of users and their roles within a team in your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/teams/{team_id}/users
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Query parameterslink
Name | Description |
---|---|
cursor | paging cursor, read more about pagination |
limit | number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"user_id": "user_id_1",
"role": "Team Member",
"created_at": "2021-09-29T10:50:51.397153Z"
},
{
"user_id": "user_id_2",
"role": "Team Manager",
"created_at": "2021-01-16T17:03:14.542743Z"
}
],
"next_cursor": "eyJza2lwIjoxfQ"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data | Response data |
items | The collection of team users |
item.user_id | The unique identifier of user |
item.role | The user's role within the team. Supported values: Team manager , Team Member |
item.created_at | The timestamp of when the membership was created |
next_cursor | The value of the cursor parameter for the next page |
Retrieve user membership in a teamlink
Returns the user role a user has within a team.
Requestlink
GET https://api.fivetran.com/v1/teams/{team_id}/users/{user_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
user_id (required) | The unique identifier for the user within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"user_id": "user_id",
"role": "Team Member",
"created_at": "2021-09-29T10:50:51.397153Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data | Response data |
data.user_id | The unique identifier of user |
data.role | The user's role within the team. Supported values: Team manager , Team Member |
data.created_at | The timestamp of when the membership was created |
Add a user to a teamlink
Assigns a user role within a team.
Requestlink
POST https://api.fivetran.com/v1/teams/{team_id}/users
{
"user_id": "user_id",
"role": "Team Member"
}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Payload parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
role (required) | The role that you would like to assign to the user. Supported values: Team Member , Team Manager |
Responselink
HTTP 201 CREATED
{
"code": "Created",
"message": "User has been added to the team",
"data": {
"user_id": "user_id",
"role": "Team Member",
"created_at": "2023-01-01T15:26:47.306509Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
data | Response data |
data.user_id | The unique identifier of user |
data.role | The user's role within the team. Supported values: Team manager , Team Member |
data.created_at | The timestamp of when the membership was created |
Modify a user membershiplink
Updates a user role within a team in your Fivetran account.
Requestlink
PATCH https://api.fivetran.com/v1/teams/{team_id}/users/{user_id}
{
"role": "Team Member"
}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
user_id (required) | The unique identifier for the user within the account. |
Payload parameterslink
Name | Description |
---|---|
role (required) | The role that you would like to assign to the user. Supported values: Team Member , Team Manager |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "User role has been updated",
"data": {
"user_id": "user_id",
"role": "Team Member",
"created_at": "2023-01-01T15:26:47.306509Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
data | Response data |
data.user_id | The unique identifier of user |
data.role | The user's role within the team. Supported values: Team manager , Team Member |
data.created_at | The timestamp of when the membership was created |
Delete a user from a teamlink
Removes a user from a team.
Requestlink
DELETE https://api.fivetran.com/v1/teams/{team_id}/users/{user_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
user_id (required) | The unique identifier for the user within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "User has been removed from the team"
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
List all connector membershipslink
Returns connector memberships within a team.
Requestlink
GET https://api.fivetran.com/v1/teams/{team_id}/connectors
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Query parameterslink
Name | Description |
---|---|
cursor | paging cursor, read more about pagination |
limit | number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "connector_id_1",
"role": "Connector Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
},
{
"id": "connector_id_2",
"role": "Connector Reviewer",
"created_at": "2020-05-25T15:26:47.306509Z"
}
],
"next_cursor": "eyJza2lwIjoxfQ"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data | Response data |
items | The collection of connector memberships |
item.id | The connector unique identifier |
item.role | The team's role that links the team and the connector |
item.created_at | The timestamp the membership was created |
next_cursor | The value of the cursor parameter for the next page |
Retrieve connector membershiplink
Returns a connector membership within a team.
Requestlink
GET https://api.fivetran.com/v1/teams/{team_id}/connectors/{connector_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
connector_id (required) | The unique identifier for the connector within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "connector_id",
"role": "Connector Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data | Response data |
data.id | The connector unique identifier |
data.role | The team's role that links the team and the connector |
data.created_at | The timestamp the membership was created |
Add connector membershiplink
Adds a connector role within a team.
Requestlink
POST https://api.fivetran.com/v1/teams/{team_id}/connectors
{
"id": "connector_id",
"role": "Connector Administrator"
}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Payload parameterslink
Name | Description |
---|---|
connector_id (required) | The unique identifier for the connector within the account. |
role (required) | The role that you would like to assign to the team to link the connector and the team. Possible values: Connector Administrator , Connector Collaborator , Connector Reviewer , or a custom role with connector level permissions. |
Responselink
HTTP 201 CREATED
{
"code": "Created",
"message": "Connector membership has been created",
"data": {
"id": "connector_id",
"role": "Connector Administrator",
"created_at": "2021-09-29T10:50:51.397153Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
data.id | The connector unique identifier |
data.role | The team's role that links the team and the connector |
data.created_at | The timestamp the membership was created |
Update connector membershiplink
Updates connector membership in a team.
Requestlink
PATCH https://api.fivetran.com/v1/teams/{team_id}/connectors/{connector_id}
{
"role": "Connector Administrator"
}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
connector_id (required) | The unique identifier for the connector within the account. |
Payload parameterslink
Name | Description |
---|---|
role (required) | The role that you would like to assign to the team to link the connector and the team. Possible values: Connector Administrator , Connector Collaborator , Connector Reviewer , or a custom role with connector level permissions. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Connector membership has been updated",
"data": {
"id": "connector_id",
"role": "Connector Administrator",
"created_at": "2021-09-29T10:50:51.397153Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
data.id | The connector unique identifier |
data.role | The team's role that links the team and the connector |
data.created_at | The timestamp the connector membership was created |
Delete connector membershiplink
Removes connector membership in a team.
Requestlink
DELETE https://api.fivetran.com/v1/teams/{team_id}/connectors/{connector_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
connector_id (required) | The unique identifier for the connector within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Connector membership has been deleted"
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
List all group membershipslink
Returns a group membership within a team.
Requestlink
GET https://api.fivetran.com/v1/teams/{team_id}/groups
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Query parameterslink
Name | Description |
---|---|
cursor | paging cursor, read more about pagination |
limit | number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "group_id_1",
"role": "Destination Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
},
{
"id": "group_id_2",
"role": "Destination Reviewer",
"created_at": "2020-05-25T15:26:47.306509Z"
}
],
"next_cursor": "eyJza2lwIjoxfQ"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data | Response data |
items | The collection of group memberships |
item.id | The group unique identifier |
item.role | The team's role that links the team and the group |
item.created_at | The timestamp the membership was created |
next_cursor | The value of the cursor parameter for the next page |
Retrieve group membershiplink
Returns a group membership within a team.
Requestlink
GET https://api.fivetran.com/v1/teams/{team_id}/groups/{group_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
group_id (required) | The unique identifier for the group within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "group_id",
"role": "Destination Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data | Response data |
data.id | The group unique identifier |
data.role | The team's role that links the team and the group |
data.created_at | The timestamp the membership was created |
Add group membershiplink
Adds a group membership in a team.
Requestlink
POST https://api.fivetran.com/v1/teams/{team_id}/groups
{
"id": "group_id",
"role": "Destination Administrator"
}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
Payload parameterslink
Name | Description |
---|---|
id (required) | The unique identifier for the group within the account. |
role (required) | The role within the group that you would like to assign to the team. Possible values: Destination Administrator , Destination Analyst , Destination Reviewer , Connector Creator , or a custom role with destination level permissions. |
Responselink
HTTP 201 CREATED
{
"code": "Created",
"message": "Group membership has been created",
"data": {
"id": "group_id",
"role": "Destination Administrator",
"created_at": "2021-09-29T10:50:51.397153Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
data | Response data |
items | The collection of group memberships |
data.id | The group unique identifier |
data.role | The role the team has within group |
data.created_at | The timestamp the membership was created |
Update group membershiplink
Updates group membership in a team.
Requestlink
PATCH https://api.fivetran.com/v1/teams/{team_id}/groups/{group_id}
{
"role": "Destination Administrator"
}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
group_id (required) | The unique identifier for the group within the account. |
Payload parameterslink
Name | Description |
---|---|
role (required) | The role within the group that you would like to assign to the team . Possible values: Destination Administrator , Destination Analyst , Destination Reviewer , Connector Creator , or a custom role with destination level permissions. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Group membership has been updated",
"data": {
"id": "group_id",
"role": "Destination Administrator",
"created_at": "2021-09-29T10:50:51.397153Z"
}
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |
items | The collection of group memberships |
data.id | The group unique identifier |
data.role | The role the team has within group |
data.created_at | The timestamp the membership was created |
Delete group membershiplink
Removes group membership in a team.
Requestlink
DELETE https://api.fivetran.com/v1/teams/{team_id}/groups/{group_id}
Path parameterslink
Name | Description |
---|---|
team_id (required) | The unique identifier for the team within the account. |
group_id (required) | The unique identifier for the group within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Group membership has been deleted"
}
Fieldslink
Name | Description |
---|---|
code | Response status code |
message | Response status text |