Teams

Was this helpful?

Get Team

get

Get a team by their ID.

Authorizations

Path parameters

idstringRequired

The ID of the team to retrieve.

Example: 3131f219-16bb-4c95-853a-894ae12db42a

Responses

200

application/json

404

Not Found

500

Internal Server Error

get

GET /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 Team

delete

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

Authorizations

Path parameters

idstringRequired

The ID of the team to delete.

Example: 3131f219-16bb-4c95-853a-894ae12db42a

Responses

204

No Content

404

Not Found

500

Internal Server Error

delete

DELETE /auth/teams/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

No content

List Teams

get

Get a list of teams in the workspace.

Authorizations

Responses

200

List of teams.

application/json

Responseall of

400

Bad Request

500

Internal Server Error

get

GET /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 Team

post

Create a new team in the workspace.

Authorizations

Body

namestringOptional

Indicates the name of the team.

Example: Test Team

iconstringOptional

Indicates the icon of the team.

Example: 😀

typestringOptional

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

Example: OPEN

descriptionstringOptional

Description of the team.

Example: This is the best team in this workspace.

Responses

201

Created

application/json

400

Bad Request

500

Internal Server Error

post

POST /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
}

Update Team

patch

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

Authorizations

Path parameters

idstringRequired

The ID of the team to update.

Example: 3131f219-16bb-4c95-853a-894ae12db42a

Body

namestringOptional

Indicates the name of the team.

Example: New Team

Responses

200

Team updated successfully

application/json

400

Bad Request

404

User not found

500

Internal Server Error

patch

PATCH /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
}