Skip to main content

Get project settings

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

Retrieves the project settings.

Required scope

projects: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 to which the project belongs.

    Example: 3074457345618265000
    team_id stringrequired

    The ID of the team to which the project belongs.

    Example: 3074457345619012091
    project_id stringrequired

    The ID of the project for which you want to retrieve the project settings.

    Example: 3074457345618265000

Responses​

Defines the sharing policies for the boards within the project.

Schema

    sharingPolicySettings

    object

    required

    teamAccess TeamAccess (string)

    Possible values: [private, view]

    Default value: private

    Team access

    • "private": Only the members of the project can access the information within the project.
    • "view": Anyone in the team can view the information in within the project.
    type stringrequired

    Default value: project_settings

    Type of the object

Loading...