Start free trial

Teams

Teams within the workspace. Learn more about team management here.

List Teams

get
/api/v1/auth/teams/

Get a list of teams in the workspace.

Authorizations
Query parameters
include_archivedbooleanOptionalDefault: false
only_joinedbooleanOptionalDefault: false
only_writebooleanOptionalDefault: false
pageany ofOptionalDefault: 1
integerOptional
or
nullOptional
Responses
200

OK

application/json
get
/api/v1/auth/teams/
GET /api/v1/auth/teams/ HTTP/1.1
Host: api.secoda.co
Accept: */*
200

OK

{
  "results": [
    {
      "sidebar_settings": {
        "ANY_ADDITIONAL_PROPERTY": true
      },
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-11-26T00:27:36.461Z",
      "updated_at": "2025-11-26T00:27:36.461Z",
      "name": "text",
      "icon": "text",
      "type": "text",
      "description": "text",
      "archived": false,
      "is_default_team": false,
      "onboarding_completed": false
    }
  ],
  "count": 1,
  "total_pages": 1,
  "meta": {
    "page": 1,
    "previous_page": 1,
    "next_page": 1
  },
  "links": {
    "previous": "text",
    "next": "text"
  }
}

Create Team

post
/api/v1/auth/teams/

Create a new team in the workspace.

Authorizations
Body
namestringRequired
iconany ofOptional
stringOptional
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
typestring · enumRequiredPossible values:
Responses
post
/api/v1/auth/teams/
POST /api/v1/auth/teams/ HTTP/1.1
Host: api.secoda.co
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "icon": "text",
  "description": "text",
  "type": "OPEN"
}
201

Created

{
  "sidebar_settings": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-11-26T00:27:36.461Z",
  "updated_at": "2025-11-26T00:27:36.461Z",
  "name": "text",
  "icon": "text",
  "type": "text",
  "description": "text",
  "archived": false,
  "is_default_team": false,
  "onboarding_completed": false
}

Get Team

get
/api/v1/auth/teams/{team_id}/

Get a team by their ID.

Authorizations
Path parameters
team_idstringRequired
Responses
200

OK

application/json
get
/api/v1/auth/teams/{team_id}/
GET /api/v1/auth/teams/{team_id}/ HTTP/1.1
Host: api.secoda.co
Accept: */*
200

OK

{
  "sidebar_settings": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-11-26T00:27:36.461Z",
  "updated_at": "2025-11-26T00:27:36.461Z",
  "name": "text",
  "icon": "text",
  "type": "text",
  "description": "text",
  "archived": false,
  "is_default_team": false,
  "onboarding_completed": false
}

Update Team

patch
/api/v1/auth/teams/{team_id}/

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

Authorizations
Path parameters
team_idstringRequired
Body
nameany ofOptional
stringOptional
or
nullOptional
iconany ofOptional
stringOptional
or
nullOptional
typeany ofOptional
string · enumOptionalPossible values:
or
nullOptional
descriptionany ofOptional
stringOptional
or
nullOptional
sidebar_settingsany ofOptional
or
nullOptional
archivedany ofOptional
booleanOptional
or
nullOptional
onboarding_completedany ofOptional
booleanOptional
or
nullOptional
Responses
200

OK

application/json
patch
/api/v1/auth/teams/{team_id}/
PATCH /api/v1/auth/teams/{team_id}/ HTTP/1.1
Host: api.secoda.co
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "name": "text",
  "icon": "text",
  "type": "OPEN",
  "description": "text",
  "sidebar_settings": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "archived": true,
  "onboarding_completed": true
}
200

OK

{
  "sidebar_settings": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-11-26T00:27:36.461Z",
  "updated_at": "2025-11-26T00:27:36.461Z",
  "name": "text",
  "icon": "text",
  "type": "text",
  "description": "text",
  "archived": false,
  "is_default_team": false,
  "onboarding_completed": false
}

Last updated

Was this helpful?