workspace

get public settings

Changed on

Returns the subset of workspace settings safe to expose to any workspace member. The full settings struct is admin-only via getSettings.

get/w/{workspace}/workspaces/get_public_settings

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/workspaces/get_public_settings
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Response

status

workspace_idstring required
slack_namestring
slack_team_idstring
teams_team_idstring
teams_team_namestring
teams_team_guidstring
mute_critical_alertsboolean
guest_access_enabledboolean required

Whether this workspace admits guest sessions. An app's own guest execution mode is inert while this is false.

add_admins_and_developers_to_forksboolean required

Whether every new fork of this workspace starts with its admins and developers as members, keeping their role.

Changes

  • 54318efce822Revision changes
    • warning

      added the new external_instance enum value to the //// response property for the response status

  • 15e73f6f3addRevision changes
    • info

      added the optional property /// to the response with the status