Teams
Was this helpful?
Was this helpful?
Get a team by their ID.
The ID of the team to retrieve.
3131f219-16bb-4c95-853a-894ae12db42aGET /api/v1/auth/teams/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
{
"id": "3131f219-16bb-4c95-853a-894ae12db42a",
"created_at": "2023-09-22T15:30:00Z",
"updated_at": "2023-09-22T15:30:00Z",
"name": "Test Team",
"icon": "😀",
"type": "OPEN",
"description": "This is the best team in this workspace.",
"sidebar_settings": {
"home": true,
"catalog": true,
"documents": true,
"questions": true,
"glossary": true,
"collections": true
},
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"archived": false,
"is_default_team": true,
"onboarding_complete": true
}Delete a team by their ID. Any resources that belong solely to this team will be set to the default team.
The ID of the team to delete.
3131f219-16bb-4c95-853a-894ae12db42aDELETE /api/v1/auth/teams/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
No content
Get a list of teams in the workspace.
GET /api/v1/auth/teams HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
{
"links": {
"next": "https://api.secoda.co/resource/all/?page=2",
"previous": "None"
},
"meta": {
"page": 1,
"previous_page": "None",
"next_page": 2
},
"count": 315,
"total_pages": 7,
"results": [
{
"id": "3131f219-16bb-4c95-853a-894ae12db42a",
"created_at": "2023-09-22T15:30:00Z",
"updated_at": "2023-09-22T15:30:00Z",
"name": "Test Team",
"icon": "😀",
"type": "OPEN",
"description": "This is the best team in this workspace.",
"sidebar_settings": {
"home": true,
"catalog": true,
"documents": true,
"questions": true,
"glossary": true,
"collections": true
},
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"archived": false,
"is_default_team": true,
"onboarding_complete": true
}
]
}Create a new team in the workspace.
Indicates the name of the team.
Test TeamIndicates the icon of the team.
😀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 - OPEN CLOSED
OPENDescription of the team.
This is the best team in this workspace.POST /api/v1/auth/teams HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 222
{
"name": "Test Team",
"icon": "😀",
"type": "OPEN",
"description": "This is the best team in this workspace.",
"sidebar_settings": {
"home": true,
"catalog": true,
"documents": true,
"questions": true,
"glossary": true,
"collections": true
}
}{
"id": "3131f219-16bb-4c95-853a-894ae12db42a",
"created_at": "2023-09-22T15:30:00Z",
"updated_at": "2023-09-22T15:30:00Z",
"name": "Test Team",
"icon": "😀",
"type": "OPEN",
"description": "This is the best team in this workspace.",
"sidebar_settings": {
"home": true,
"catalog": true,
"documents": true,
"questions": true,
"glossary": true,
"collections": true
},
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"archived": false,
"is_default_team": true,
"onboarding_complete": true
}Use this endpoint to update the Team. Editable fields include the name, description, icon, type, and sidebar settings.
The ID of the team to update.
3131f219-16bb-4c95-853a-894ae12db42aIndicates the name of the team.
New TeamPATCH /api/v1/auth/teams/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"name": "New Team"
}{
"id": "3131f219-16bb-4c95-853a-894ae12db42a",
"created_at": "2023-09-22T15:30:00Z",
"updated_at": "2023-09-22T15:30:00Z",
"name": "Test Team",
"icon": "😀",
"type": "OPEN",
"description": "This is the best team in this workspace.",
"sidebar_settings": {
"home": true,
"catalog": true,
"documents": true,
"questions": true,
"glossary": true,
"collections": true
},
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"archived": false,
"is_default_team": true,
"onboarding_complete": true
}