# Teams

Teams within the workspace. Learn more about team management [here](https://docs.secoda.co/user-management/teams).

## List Teams

> Get a list of teams in the workspace.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"1.0.0"},"tags":[{"name":"Teams","description":"Teams within the workspace. Learn more about team management [here](https://docs.secoda.co/user-management/teams).\n"}],"servers":[{"url":"https://api.secoda.co/api/v1","description":"Base URL for all US cloud based workspaces (API v1)."},{"url":"https://api.secoda.co/api/v2","description":"Base URL for all US cloud based workspaces (API v2)."},{"url":"https://eapi.secoda.co/api/v1","description":"Base URL for all EU cloud based workspaces (API v1)."},{"url":"https://eapi.secoda.co/api/v2","description":"Base URL for all EU cloud based workspaces (API v2)."},{"url":"https://aapi.secoda.co/api/v1","description":"Base URL for all APAC cloud based workspaces (API v1)."},{"url":"https://aapi.secoda.co/api/v2","description":"Base URL for all APAC cloud based workspaces (API v2)."},{"url":"https://{customer_domain}.secoda.co/api/v1","description":"Base URL for On Premise Secoda workspaces (API v1).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}},{"url":"https://{customer_domain}.secoda.co/api/v2","description":"Base URL for On Premise Secoda workspaces (API v2).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"string"}}},"paths":{"/auth/teams":{"get":{"tags":["Teams"],"summary":"List Teams","description":"Get a list of teams in the workspace.","responses":{"200":{"description":"List of teams.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"links":{"type":"object","description":"Indicates Links to associated pages.","properties":{"next":{"type":"string","description":"The link to the next page (null if there are no more pages)."},"previous":{"type":"string","description":"The link to the previous page (null if on the first page)."}}},"meta":{"type":"object","description":"Reprents the meta data of the response.","properties":{"page":{"type":"integer","description":"The current page number."},"previous_page":{"type":"integer","description":"The previous page number (null if on the first page)."},"next_page":{"type":"integer","description":"The next page number (null if on the last page)."}}},"count":{"type":"integer","description":"The total count of items returned."},"total_pages":{"type":"integer","description":"The total number of pages."}}},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Indicates the UUID of the team."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the team was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the team was last updated in Secoda UTC format."},"name":{"type":"string","description":"Indicates the name of the team."},"icon":{"type":"string","description":"Indicates the icon of the team."},"type":{"type":"string","description":"Indicates the type of the team. If a team is Open, this means it is Public and can be joined by anyone in the workspace. If a team is Closed, the team is private and only admins can invite members into the team. Values can be - <ul><li> OPEN <li> CLOSED </ul>"},"description":{"type":"string","description":"Description of the team."},"sidebar_settings":{"type":"object","description":"Use these settings to toggle which pages should be shown to team members in the side bar.","properties":{"home":{"type":"boolean","description":"Whether to show the home page to team members."},"catalog":{"type":"boolean","description":"Whether to show the catalog page to team members."},"documents":{"type":"boolean","description":"Whether to show the documents page to team members."},"questions":{"type":"boolean","description":"Whether to show the questions page to team members."},"glossary":{"type":"boolean","description":"Whether to show the glossary page to team members."},"collections":{"type":"boolean","description":"Whether to show the collections page to team members."}}},"workspace_id":{"type":"string","description":"Indicates the workspace ID of the user."},"archived":{"type":"boolean","description":"Indicates if the team has been deleted."},"is_default_team":{"type":"boolean","description":"Indicates if the team is the default team. Any resource without a specified team will automatically get added to this team."},"onboarding_complete":{"type":"boolean","description":"This field will be deprecated."}}}}}}]}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}}}}
```

## Create Team

> Create a new team in the workspace.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"1.0.0"},"tags":[{"name":"Teams","description":"Teams within the workspace. Learn more about team management [here](https://docs.secoda.co/user-management/teams).\n"}],"servers":[{"url":"https://api.secoda.co/api/v1","description":"Base URL for all US cloud based workspaces (API v1)."},{"url":"https://api.secoda.co/api/v2","description":"Base URL for all US cloud based workspaces (API v2)."},{"url":"https://eapi.secoda.co/api/v1","description":"Base URL for all EU cloud based workspaces (API v1)."},{"url":"https://eapi.secoda.co/api/v2","description":"Base URL for all EU cloud based workspaces (API v2)."},{"url":"https://aapi.secoda.co/api/v1","description":"Base URL for all APAC cloud based workspaces (API v1)."},{"url":"https://aapi.secoda.co/api/v2","description":"Base URL for all APAC cloud based workspaces (API v2)."},{"url":"https://{customer_domain}.secoda.co/api/v1","description":"Base URL for On Premise Secoda workspaces (API v1).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}},{"url":"https://{customer_domain}.secoda.co/api/v2","description":"Base URL for On Premise Secoda workspaces (API v2).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"string"}}},"paths":{"/auth/teams":{"post":{"tags":["Teams"],"summary":"Create Team","description":"Create a new team in the workspace.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Indicates the name of the team."},"icon":{"type":"string","description":"Indicates the icon of the team."},"type":{"type":"string","description":"Indicates the type of the team. If a team is Open, this means it is Public and can be joined by anyone in the workspace. If a team is Closed, the team is private and only admins can invite members into the team. Values can be - <ul><li> OPEN <li> CLOSED </ul>"},"description":{"type":"string","description":"Description of the team."},"sidebar_settings":{"type":"object","description":"Use these settings to toggle which pages should be shown to team members in the side bar.","properties":{"home":{"type":"boolean","description":"Whether to show the home page to team members."},"catalog":{"type":"boolean","description":"Whether to show the catalog page to team members."},"documents":{"type":"boolean","description":"Whether to show the documents page to team members."},"questions":{"type":"boolean","description":"Whether to show the questions page to team members."},"glossary":{"type":"boolean","description":"Whether to show the glossary page to team members."},"collections":{"type":"boolean","description":"Whether to show the collections page to team members."}}}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Indicates the UUID of the team."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the team was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the team was last updated in Secoda UTC format."},"name":{"type":"string","description":"Indicates the name of the team."},"icon":{"type":"string","description":"Indicates the icon of the team."},"type":{"type":"string","description":"Indicates the type of the team. If a team is Open, this means it is Public and can be joined by anyone in the workspace. If a team is Closed, the team is private and only admins can invite members into the team. Values can be - <ul><li> OPEN <li> CLOSED </ul>"},"description":{"type":"string","description":"Description of the team."},"sidebar_settings":{"type":"object","description":"Use these settings to toggle which pages should be shown to team members in the side bar.","properties":{"home":{"type":"boolean","description":"Whether to show the home page to team members."},"catalog":{"type":"boolean","description":"Whether to show the catalog page to team members."},"documents":{"type":"boolean","description":"Whether to show the documents page to team members."},"questions":{"type":"boolean","description":"Whether to show the questions page to team members."},"glossary":{"type":"boolean","description":"Whether to show the glossary page to team members."},"collections":{"type":"boolean","description":"Whether to show the collections page to team members."}}},"workspace_id":{"type":"string","description":"Indicates the workspace ID of the user."},"archived":{"type":"boolean","description":"Indicates if the team has been deleted."},"is_default_team":{"type":"boolean","description":"Indicates if the team is the default team. Any resource without a specified team will automatically get added to this team."},"onboarding_complete":{"type":"boolean","description":"This field will be deprecated."}}}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}}}}
```

## Get Team

> Get a team by their ID.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"1.0.0"},"tags":[{"name":"Teams","description":"Teams within the workspace. Learn more about team management [here](https://docs.secoda.co/user-management/teams).\n"}],"servers":[{"url":"https://api.secoda.co/api/v1","description":"Base URL for all US cloud based workspaces (API v1)."},{"url":"https://api.secoda.co/api/v2","description":"Base URL for all US cloud based workspaces (API v2)."},{"url":"https://eapi.secoda.co/api/v1","description":"Base URL for all EU cloud based workspaces (API v1)."},{"url":"https://eapi.secoda.co/api/v2","description":"Base URL for all EU cloud based workspaces (API v2)."},{"url":"https://aapi.secoda.co/api/v1","description":"Base URL for all APAC cloud based workspaces (API v1)."},{"url":"https://aapi.secoda.co/api/v2","description":"Base URL for all APAC cloud based workspaces (API v2)."},{"url":"https://{customer_domain}.secoda.co/api/v1","description":"Base URL for On Premise Secoda workspaces (API v1).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}},{"url":"https://{customer_domain}.secoda.co/api/v2","description":"Base URL for On Premise Secoda workspaces (API v2).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"string"}}},"paths":{"/auth/teams/{id}":{"get":{"tags":["Teams"],"summary":"Get Team","description":"Get a team by their ID.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the team to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Indicates the UUID of the team."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the team was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the team was last updated in Secoda UTC format."},"name":{"type":"string","description":"Indicates the name of the team."},"icon":{"type":"string","description":"Indicates the icon of the team."},"type":{"type":"string","description":"Indicates the type of the team. If a team is Open, this means it is Public and can be joined by anyone in the workspace. If a team is Closed, the team is private and only admins can invite members into the team. Values can be - <ul><li> OPEN <li> CLOSED </ul>"},"description":{"type":"string","description":"Description of the team."},"sidebar_settings":{"type":"object","description":"Use these settings to toggle which pages should be shown to team members in the side bar.","properties":{"home":{"type":"boolean","description":"Whether to show the home page to team members."},"catalog":{"type":"boolean","description":"Whether to show the catalog page to team members."},"documents":{"type":"boolean","description":"Whether to show the documents page to team members."},"questions":{"type":"boolean","description":"Whether to show the questions page to team members."},"glossary":{"type":"boolean","description":"Whether to show the glossary page to team members."},"collections":{"type":"boolean","description":"Whether to show the collections page to team members."}}},"workspace_id":{"type":"string","description":"Indicates the workspace ID of the user."},"archived":{"type":"boolean","description":"Indicates if the team has been deleted."},"is_default_team":{"type":"boolean","description":"Indicates if the team is the default team. Any resource without a specified team will automatically get added to this team."},"onboarding_complete":{"type":"boolean","description":"This field will be deprecated."}}}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}}}
```

## Delete Team

> Delete a team by their ID. Any resources that belong solely to this team will be set to the default team.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"1.0.0"},"tags":[{"name":"Teams","description":"Teams within the workspace. Learn more about team management [here](https://docs.secoda.co/user-management/teams).\n"}],"servers":[{"url":"https://api.secoda.co/api/v1","description":"Base URL for all US cloud based workspaces (API v1)."},{"url":"https://api.secoda.co/api/v2","description":"Base URL for all US cloud based workspaces (API v2)."},{"url":"https://eapi.secoda.co/api/v1","description":"Base URL for all EU cloud based workspaces (API v1)."},{"url":"https://eapi.secoda.co/api/v2","description":"Base URL for all EU cloud based workspaces (API v2)."},{"url":"https://aapi.secoda.co/api/v1","description":"Base URL for all APAC cloud based workspaces (API v1)."},{"url":"https://aapi.secoda.co/api/v2","description":"Base URL for all APAC cloud based workspaces (API v2)."},{"url":"https://{customer_domain}.secoda.co/api/v1","description":"Base URL for On Premise Secoda workspaces (API v1).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}},{"url":"https://{customer_domain}.secoda.co/api/v2","description":"Base URL for On Premise Secoda workspaces (API v2).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"string"}}},"paths":{"/auth/teams/{id}":{"delete":{"tags":["Teams"],"summary":"Delete Team","description":"Delete a team by their ID. Any resources that belong solely to this team will be set to the default team.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the team to delete.","schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}}}
```

## Update Team

> Use this endpoint to update the Team. Editable fields include the name, description, icon, type, and sidebar settings.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"1.0.0"},"tags":[{"name":"Teams","description":"Teams within the workspace. Learn more about team management [here](https://docs.secoda.co/user-management/teams).\n"}],"servers":[{"url":"https://api.secoda.co/api/v1","description":"Base URL for all US cloud based workspaces (API v1)."},{"url":"https://api.secoda.co/api/v2","description":"Base URL for all US cloud based workspaces (API v2)."},{"url":"https://eapi.secoda.co/api/v1","description":"Base URL for all EU cloud based workspaces (API v1)."},{"url":"https://eapi.secoda.co/api/v2","description":"Base URL for all EU cloud based workspaces (API v2)."},{"url":"https://aapi.secoda.co/api/v1","description":"Base URL for all APAC cloud based workspaces (API v1)."},{"url":"https://aapi.secoda.co/api/v2","description":"Base URL for all APAC cloud based workspaces (API v2)."},{"url":"https://{customer_domain}.secoda.co/api/v1","description":"Base URL for On Premise Secoda workspaces (API v1).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}},{"url":"https://{customer_domain}.secoda.co/api/v2","description":"Base URL for On Premise Secoda workspaces (API v2).","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"string"}}},"paths":{"/auth/teams/{id}":{"patch":{"tags":["Teams"],"summary":"Update Team","description":"Use this endpoint to update the Team. Editable fields include the name, description, icon, type, and sidebar settings.","parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the team to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Indicates the name of the team."}}}}}},"responses":{"200":{"description":"Team updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Indicates the UUID of the team."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the team was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the team was last updated in Secoda UTC format."},"name":{"type":"string","description":"Indicates the name of the team."},"icon":{"type":"string","description":"Indicates the icon of the team."},"type":{"type":"string","description":"Indicates the type of the team. If a team is Open, this means it is Public and can be joined by anyone in the workspace. If a team is Closed, the team is private and only admins can invite members into the team. Values can be - <ul><li> OPEN <li> CLOSED </ul>"},"description":{"type":"string","description":"Description of the team."},"sidebar_settings":{"type":"object","description":"Use these settings to toggle which pages should be shown to team members in the side bar.","properties":{"home":{"type":"boolean","description":"Whether to show the home page to team members."},"catalog":{"type":"boolean","description":"Whether to show the catalog page to team members."},"documents":{"type":"boolean","description":"Whether to show the documents page to team members."},"questions":{"type":"boolean","description":"Whether to show the questions page to team members."},"glossary":{"type":"boolean","description":"Whether to show the glossary page to team members."},"collections":{"type":"boolean","description":"Whether to show the collections page to team members."}}},"workspace_id":{"type":"string","description":"Indicates the workspace ID of the user."},"archived":{"type":"boolean","description":"Indicates if the team has been deleted."},"is_default_team":{"type":"boolean","description":"Indicates if the team is the default team. Any resource without a specified team will automatically get added to this team."},"onboarding_complete":{"type":"boolean","description":"This field will be deprecated."}}}}}},"400":{"description":"Bad Request"},"404":{"description":"User not found"},"500":{"description":"Internal Server Error"}}}}}}
```
