Sign in
Organizations

Get organization settings

Retrieve the settings for a specific organization by ID.

get/api/organizations/{id}

Path parameters

idinteger required

Response

created_atstring date-time required
custom_interfaces_enabledboolean nullable

Enable custom interfaces for this organization. When disabled, projects with use_custom_interface=True will not render custom interfaces anywhere in the product (label stream, embed, data manager, interfaces dashboard).

custom_scripts_enabledboolean required
default_role'OW' | 'AD' | 'MA' | 'RE' | 'AN' | 'DI' | 'NO' | 'VO'
  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
  • VO - View Only
email_notification_settingsobject required

Get email notification settings with default values for all notification types.

Returns a dictionary with the following structure: { 'notifications_allowed': { 'notification_type': bool }, 'notification_types': [ {'value': str, 'label': str} ] }

Excludes blocklisted notification types and ensures all valid types are included with proper defaults for any missing types.

When organization's email_notification_settings is null or empty, all notifications are shown as enabled (True) by default. When organization has some settings, unconfigured notifications default to False.

{"stackTrail":"components:schemas:LseOrganization:properties:embed_domains","oasType":"schema","type":"unknown","description":"List of objects: {\"domain\": \"example.com\"}. Used for CSP header on /embed routes.","nullable":true}
embed_enabledboolean nullable

Enable embed functionality for this organization

{"stackTrail":"components:schemas:LseOrganization:properties:embed_settings","oasType":"schema","type":"unknown","description":"Embed settings for this organization","nullable":true}
external_idstring nullable

External ID to uniquely identify this organization

idinteger required
{"stackTrail":"components:schemas:LseOrganization:properties:interface_settings","oasType":"schema","type":"unknown","description":"Security settings for custom interfaces: CSP allowlists, script origins, iframe permissions.","nullable":true}
react_code_settingsobject required
titlestring required
tokenstring required

Changes

Changed in 4 of the 97 revisions of this API.815

  • d61bc77f80bc1See the full diff
    • ●

      added the new VO enum value to the default_role/allOf[OrganizationRoleEnum]/ response property for the response status 200

      response-property-enum-value-added

  • b5f055b9d45b8See the full diff
    • ▲

      the billing/enforce_session_concurrency response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the billing/manual_role_management response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the billing/manual_workspace_management response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the billing/max_parallel_sessions response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the billing/session_concurrency_window_seconds response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • ▲

      the custom_scripts_enabled response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the email_notification_settings response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ▲

      the react_code_settings response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

  • 04ff286141b52See the full diff
    • ○

      added OrganizationRoleEnum to the default_role response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed Role9e7Enum from the default_role response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b7b3b45888a83See the full diff
    • ○

      added the optional property custom_interfaces_enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property embed_enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property interface_settings to the response with the 200 status

      response-optional-property-added

Of the 97 revisions, 1 has no diff computed.