Skip to main content

Get team settings

GET 
/v2/orgs/:org_id/teams/:team_id/settings

Retrieves team settings of an existing team.

Required scope

organizations:teams:read

Rate limiting

Level 1

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request​

Path Parameters

    org_id stringrequired

    The id of the Organization.

    Example: 3074457345618265000
    team_id stringrequired

    The id of the Team.

    Example: 3074457345618265000

Responses​

Team settings

Schema

    organizationId string

    Organization id

    teamAccountDiscoverySettings

    object

    Team account discovery settings

    accountDiscovery string

    Possible values: [hidden, request, join]

    • "hidden": Only invited users can see and access the team.
    • "request": Members of organization can find and request to join with admin approval.
    • "join": Members of organization can find and join.

    teamCollaborationSettings

    object

    Team collaboration settings

    coOwnerRole string

    Possible values: [enabled, disabled]

    • "enabled": Enable Co-owner role on boards and projects
    • "disabled": Disabled Co-owner role on boards and projects

    teamCopyAccessLevelSettings

    object

    Team copy access settings

    copyAccessLevel string

    Possible values: [anyone, team_members, team_editors, board_owner -]

    • "anyone": Anyone with the board access can copy board content on newly created boards.
    • "team_members": Team members can copy board content on newly created boards.
    • "team_editors": Team members with editing rights can copy board content on newly created boards.
    • "board_owner": Board owners only can copy board content on newly created boards.
    copyAccessLevelLimitation string

    Possible values: [anyone, team_members]

    • "anyone": Team members and users outside team can be given permission to copy board content.
    • "team_members": Only team members can be given permission to copy board content.
    teamId string

    Team id

    teamInvitationSettings

    object

    Team invitation settings

    inviteExternalUsers string

    Possible values: [allowed, not_allowed]

    • "allowed": Allow non-team collaborators for team
    • "not_allowed": Not Allow non-team collaborators for team
    whoCanInvite string

    Possible values: [only_org_admins, admins, all_members]

    • "only_org_admins": Company admins only can invite
    • "admins": Company admins and team admins can invite
    • "all_members": All team members can invite

    teamSharingPolicySettings

    object

    Team sharing policy settings

    allowListedDomains string[]

    Allow listed domains

    createAssetAccessLevel string

    Possible values: [company_admins, admins, all_members]

    • "company_admins": Only company admins can create assets in a team
    • "admins": Both team and company admins can create assets in a team.
    • "all_members": all_members
    defaultBoardAccess string

    Possible values: [private, view, comment, edit]

    Default board access

    • "private": Only board owners can access
    • "view": Anyone in the team can view
    • "comment": Anyone in the team can comment
    • "edit": Anyone in the team can edit
    defaultOrganizationAccess string

    Possible values: [private, view, comment, edit]

    Default organization access

    • "private": Only board owners can access
    • "view": Anyone in the team can view
    • "comment": Anyone in the team can comment
    • "edit": Anyone in the team can edit
    defaultProjectAccess string

    Possible values: [private, view]

    Default project access

    • "private": Only board owners can access
    • "view": Anyone in the team can view
    moveBoardToAccount string

    Possible values: [allowed, not_allowed]

    • "allowed": Allow move board to team
    • "not_allowed": Not allow move board to team
    restrictAllowedDomains string

    Possible values: [enabled, enabled_with_external_user_access, disabled]

    • "enabled": Enabled. Restrict to listed domain.
    • "disabled": Disabled. No domain restriction.
    • "enabled_with_external_users_access": Enabled. Restrict to listed domain but allows external users to access.
    sharingOnAccount string

    Possible values: [allowed, not_allowed]

    • "allowed": Allow sharing on team
    • "not_allowed": Not allow sharing on team
    sharingOnOrganization string

    Possible values: [allowed, allowed_with_editing, not_allowed]

    • "allowed": Allow sharing on organization
    • "allowed_with_editing": Allow sharing with editing on organization
    • "not_allowed": Not allow sharing on organization
    sharingViaPublicLink string

    Possible values: [allowed, allowed_with_editing, not_allowed]

    • "allowed": Allow sharing via public link
    • "allowed_with_editing": Allow sharing with editing via public link
    • "not_allowed": Not allow sharing via public link
    type string

    Default value: team-settings

    Type of the object returned.

Loading...