Teams

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

List Teams

get

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v1/auth/teams/

Get a paginated list of teams in the workspace.

Authorizations

ApiKeyAuth

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/

HTTPcURLJavaScriptPython

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": "2025-12-16T21:20:32.360Z",
      "updated_at": "2025-12-16T21:20:32.360Z",
      "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

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v1/auth/teams/

Create a new team in the workspace.

Authorizations

ApiKeyAuth

Body

application/json

namestringRequired

iconany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

typestring · enumRequiredPossible values:

Responses

201

Created

application/json

post

/api/v1/auth/teams/

HTTPcURLJavaScriptPython

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": "2025-12-16T21:20:32.360Z",
  "updated_at": "2025-12-16T21:20:32.360Z",
  "name": "text",
  "icon": "text",
  "type": "text",
  "description": "text",
  "archived": false,
  "is_default_team": false,
  "onboarding_completed": false
}

Get Team

get

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

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

Get a team by their ID.

Authorizations

ApiKeyAuth

Path parameters

team_idstringRequired

Responses

200

OK

application/json

get

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

HTTPcURLJavaScriptPython

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": "2025-12-16T21:20:32.360Z",
  "updated_at": "2025-12-16T21:20:32.360Z",
  "name": "text",
  "icon": "text",
  "type": "text",
  "description": "text",
  "archived": false,
  "is_default_team": false,
  "onboarding_completed": false
}

Update Team

patch

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/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

ApiKeyAuth

Path parameters

team_idstringRequired

Body

application/json

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

HTTPcURLJavaScriptPython

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": "2025-12-16T21:20:32.360Z",
  "updated_at": "2025-12-16T21:20:32.360Z",
  "name": "text",
  "icon": "text",
  "type": "text",
  "description": "text",
  "archived": false,
  "is_default_team": false,
  "onboarding_completed": false
}

List Teams

get

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v2/auth/teams/

Get a list of teams in the workspace.

Authorizations

ApiKeyAuth

Query parameters

include_archivedbooleanOptionalDefault: false

only_joinedbooleanOptionalDefault: false

only_writebooleanOptionalDefault: false

Responses

200

OK

application/json

get

/api/v2/auth/teams/

HTTPcURLJavaScriptPython

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": "2025-12-16T21:20:32.360Z",
    "updated_at": "2025-12-16T21:20:32.360Z",
    "name": "text",
    "icon": "text",
    "type": "text",
    "description": "text",
    "archived": false,
    "is_default_team": false,
    "onboarding_completed": false
  }
]