Ctrlk
Start free trial
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Teams

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

List Teams

get
/api/v1/auth/teams/

Get a paginated list of teams in the workspace.

Authorizations
Query parameters
include_archivedbooleanOptionalDefault: false
only_joinedbooleanOptionalDefault: false
only_writebooleanOptionalDefault: false
pageinteger · nullableOptionalDefault: 1
Responses
200

OK

application/json
countintegerRequired
total_pagesintegerRequired
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",
      "empty_state": {
        "catalog": {
          "is_empty": true
        },
        "collection": {
          "is_empty": true
        },
        "glossary": {
          "is_empty": true
        },
        "document": {
          "is_empty": true
        },
        "question": {
          "is_empty": true
        },
        "bi_dashboard": {
          "is_empty": true
        }
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "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
iconstring · nullableOptional
descriptionstring · nullableOptional
typestring · enumRequiredPossible values:
Responses
201

Created

application/json
workspace_idstring · uuidRequired
idstring · uuidOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
namestringRequired
iconstring · nullableOptional
typestring · max: 6Required
descriptionstring · nullableOptional
archivedbooleanOptionalDefault: false
is_default_teambooleanOptionalDefault: false
onboarding_completedbooleanOptionalDefault: false
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",
  "empty_state": {
    "catalog": {
      "is_empty": true
    },
    "collection": {
      "is_empty": true
    },
    "glossary": {
      "is_empty": true
    },
    "document": {
      "is_empty": true
    },
    "question": {
      "is_empty": true
    },
    "bi_dashboard": {
      "is_empty": true
    }
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "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
workspace_idstring · uuidRequired
idstring · uuidOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
namestringRequired
iconstring · nullableOptional
typestring · max: 6Required
descriptionstring · nullableOptional
archivedbooleanOptionalDefault: false
is_default_teambooleanOptionalDefault: false
onboarding_completedbooleanOptionalDefault: false
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",
  "empty_state": {
    "catalog": {
      "is_empty": true
    },
    "collection": {
      "is_empty": true
    },
    "glossary": {
      "is_empty": true
    },
    "document": {
      "is_empty": true
    },
    "question": {
      "is_empty": true
    },
    "bi_dashboard": {
      "is_empty": true
    }
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "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
namestring · nullableOptional
iconstring · nullableOptional
typestring · enum · nullableOptionalPossible values:
descriptionstring · nullableOptional
archivedboolean · nullableOptional
onboarding_completedboolean · nullableOptional
Responses
200

OK

application/json
workspace_idstring · uuidRequired
idstring · uuidOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
namestringRequired
iconstring · nullableOptional
typestring · max: 6Required
descriptionstring · nullableOptional
archivedbooleanOptionalDefault: false
is_default_teambooleanOptionalDefault: false
onboarding_completedbooleanOptionalDefault: false
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",
  "empty_state": {
    "catalog": {
      "is_empty": true
    },
    "collection": {
      "is_empty": true
    },
    "glossary": {
      "is_empty": true
    },
    "document": {
      "is_empty": true
    },
    "question": {
      "is_empty": true
    },
    "bi_dashboard": {
      "is_empty": true
    }
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "icon": "text",
  "type": "text",
  "description": "text",
  "archived": false,
  "is_default_team": false,
  "onboarding_completed": false
}

List Teams

get
/api/v2/auth/teams/

Get a list of teams in the workspace.

Authorizations
Query parameters
include_archivedbooleanOptionalDefault: false
only_joinedbooleanOptionalDefault: false
only_writebooleanOptionalDefault: false
Responses
200

OK

application/json
workspace_idstring · uuidRequired
idstring · uuidOptional
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
namestringRequired
iconstring · nullableOptional
typestring · max: 6Required
descriptionstring · nullableOptional
archivedbooleanOptionalDefault: false
is_default_teambooleanOptionalDefault: false
onboarding_completedbooleanOptionalDefault: false
get/api/v2/auth/teams/
GET /api/v2/auth/teams/ HTTP/1.1
Host: api.secoda.co
Accept: */*
200

OK

[
  {
    "sidebar_settings": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "empty_state": {
      "catalog": {
        "is_empty": true
      },
      "collection": {
        "is_empty": true
      },
      "glossary": {
        "is_empty": true
      },
      "document": {
        "is_empty": true
      },
      "question": {
        "is_empty": true
      },
      "bi_dashboard": {
        "is_empty": true
      }
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "icon": "text",
    "type": "text",
    "description": "text",
    "archived": false,
    "is_default_team": false,
    "onboarding_completed": false
  }
]

Last updated

Was this helpful?