Skip to main content

Organization

The API key's organization and its settings: its name and default timezone, the email domains members may be invited from, how reports update and link to their sources, and which features are on, such as insights, memories, spreadsheets and email analytics.

Anyone with organization:read can read the settings. Changing them needs organization:write, which only owners and admins can grant a key.

Get organization

GET https://api.rollstack.com/public/v1/organization

The API key's organization and its settings: its name and default timezone, the email domains members may be invited from, how reports update and link to their sources, and which features are on.

Requires the organization:read scope.

Operation ID: getOrganization.

Response 200

Success

application/json

  • id (string, required): Unique identifier for the organization: the same id that getMe returns in organization.
  • name (string, required): The organization's name, as shown in Rollstack.
  • timezone (string or null, required): The organization's default timezone for reports. Reports created while it is set, including with createReport, start with it as their timezone; changing it doesn't change the timezone of existing reports. For reports that update a file in your drive, such as Google Slides presentations, it also replaces each report's own timezone for its date variables. null means no default. An IANA timezone name, such as America/New_York.
  • allowedDomains (array of string or null, required): The organization's domain allowlist, such as acme.com: the email domains people can be invited to the organization from. While it is empty or null, invites from the app aren't limited by domain, but createInvites fails with invites-require-allowed-domains. Owners and admins edit it in the organization settings in Rollstack; the API can't change it. A domain matches exactly, ignoring case, so acme.com doesn't cover eu.acme.com.
  • updateMethod (string or null, required): How reports that update a file in your drive, such as Google Slides or PowerPoint presentations, change that file when they run. The reports this API manages don't use it. update updates the same file with the latest data. archive first saves a copy of the file, named with the date of its previous run, then updates the original; runs that update only some of the report's visualizations skip the copy. updateVisualizations is the method email reports are created with; the app doesn't offer it as an organization setting. While set, every such report uses it instead of its own update method; null lets each report use its own. One of update, archive, updateVisualizations.
  • linkOption (string or null, required): Where a click on a visualization's image leads, in reports that update a file in your drive, such as Google Slides presentations. The reports this API manages don't use it. rollstack opens the visualization's page in Rollstack, external opens the dashboard or spreadsheet it comes from, and nolink leaves images without a link. While set, every such report uses it instead of its own link option; null lets each report use its own. One of nolink, rollstack, external.
  • llmProvider (string, required): The AI provider Rollstack tries first when it writes the organization's Insights, such as openai, azure_openai or amazon_bedrock; another provider may write them as a fallback. It isn't the custom LLM provider the slides agent runs on, which getLLMProvider returns. The API can't change it. custom_provider is a legacy value. One of openai, azure_openai, google_gemini, amazon_bedrock, google_ai_studio, google_vertex_ai, anthropic, custom_provider.
  • insightsEnabled (boolean, required): Whether the organization's reports can have Insights: AI-written commentary on the data in a report's visualizations. While off, no one can add or edit Insights, and runs leave existing ones unchanged.
  • memoriesEnabled (boolean, required): Whether members can use AI Memories: personal notes the AI draws on when it writes their Insights, such as to write large numbers with K, M or B. Each member keeps theirs, grouped in profiles, on the Insight Memories settings page, which is hidden while AI Memories are off.
  • spreadsheetsEnabled (boolean, required): Whether Rollstack offers Google Sheets and Microsoft Excel spreadsheets as data sources. While off, the app no longer offers them when someone adds a data source. Only the app checks this setting.
  • emailAnalyticsEnabled (boolean, required): Whether Rollstack can track when report emails are opened. While on, a report's emails are tracked once its email settings turn email analytics on (emailAnalyticsEnabled). While off, no report email is tracked, whatever its settings say.

Update organization

PATCH https://api.rollstack.com/public/v1/organization

Changes the API key's organization settings. Send only the fields to change, at least one; null clears the timezone, update method or link option.

Requires the organization:write scope. Only owners and admins of the organization may call it.

Operation ID: updateOrganization. Only owners and admins can call it.

Headers

  • Idempotency-Key (string): A unique value, such as a UUID, that makes retrying this call safe. A retry with the same key within 24 hours answers the first call's result instead of running it again. Use a new key for each new call. From 1 to 255 printable ASCII characters.

Request body, required

application/json

  • name (string): The organization's new name, as shown to its members in Rollstack. Example: Acme.
  • timezone (string or null): The organization's default timezone for reports. Reports created while it is set, including with createReport, start with it as their timezone; changing it doesn't change the timezone of existing reports. For reports that update a file in your drive, such as Google Slides presentations, it also replaces each report's own timezone for its date variables. null means no default. An IANA timezone name, such as America/New_York. Example: America/New_York.
  • updateMethod (string or null): How reports that update a file in your drive, such as Google Slides or PowerPoint presentations, change that file when they run. The reports this API manages don't use it. update updates the same file with the latest data. archive first saves a copy of the file, named with the date of its previous run, then updates the original; runs that update only some of the report's visualizations skip the copy. updateVisualizations is the method email reports are created with; the app doesn't offer it as an organization setting. While set, every such report uses it instead of its own update method; null lets each report use its own. One of update, archive, updateVisualizations.
  • linkOption (string or null): Where a click on a visualization's image leads, in reports that update a file in your drive, such as Google Slides presentations. The reports this API manages don't use it. rollstack opens the visualization's page in Rollstack, external opens the dashboard or spreadsheet it comes from, and nolink leaves images without a link. While set, every such report uses it instead of its own link option; null lets each report use its own. One of nolink, rollstack, external.
  • insightsEnabled (boolean): Whether the organization's reports can have Insights: AI-written commentary on the data in a report's visualizations. While off, no one can add or edit Insights, and runs leave existing ones unchanged. Only owners can change it, not admins.
  • restrictInsightUsers (boolean): Whether only the members you pick can use Insights, rather than everyone in the organization. Pick them with each member's insightsEnabled in updateMember. getOrganization doesn't return this setting. Only owners can change it, not admins.
  • memoriesEnabled (boolean): Whether members can use AI Memories: personal notes the AI draws on when it writes their Insights, such as to write large numbers with K, M or B. Each member keeps theirs, grouped in profiles, on the Insight Memories settings page, which is hidden while AI Memories are off. Only owners can change it, not admins.
  • spreadsheetsEnabled (boolean): Whether Rollstack offers Google Sheets and Microsoft Excel spreadsheets as data sources. While off, the app no longer offers them when someone adds a data source. Only the app checks this setting. Only owners can change it, not admins.
  • emailAnalyticsEnabled (boolean): Whether Rollstack can track when report emails are opened. While on, a report's emails are tracked once its email settings turn email analytics on (emailAnalyticsEnabled). While off, no report email is tracked, whatever its settings say. Only owners can change it, not admins.

Response 200

Success

application/json

  • id (string, required): Unique identifier for the organization: the same id that getMe returns in organization.
  • name (string, required): The organization's name, as shown in Rollstack.
  • timezone (string or null, required): The organization's default timezone for reports. Reports created while it is set, including with createReport, start with it as their timezone; changing it doesn't change the timezone of existing reports. For reports that update a file in your drive, such as Google Slides presentations, it also replaces each report's own timezone for its date variables. null means no default. An IANA timezone name, such as America/New_York.
  • allowedDomains (array of string or null, required): The organization's domain allowlist, such as acme.com: the email domains people can be invited to the organization from. While it is empty or null, invites from the app aren't limited by domain, but createInvites fails with invites-require-allowed-domains. Owners and admins edit it in the organization settings in Rollstack; the API can't change it. A domain matches exactly, ignoring case, so acme.com doesn't cover eu.acme.com.
  • updateMethod (string or null, required): How reports that update a file in your drive, such as Google Slides or PowerPoint presentations, change that file when they run. The reports this API manages don't use it. update updates the same file with the latest data. archive first saves a copy of the file, named with the date of its previous run, then updates the original; runs that update only some of the report's visualizations skip the copy. updateVisualizations is the method email reports are created with; the app doesn't offer it as an organization setting. While set, every such report uses it instead of its own update method; null lets each report use its own. One of update, archive, updateVisualizations.
  • linkOption (string or null, required): Where a click on a visualization's image leads, in reports that update a file in your drive, such as Google Slides presentations. The reports this API manages don't use it. rollstack opens the visualization's page in Rollstack, external opens the dashboard or spreadsheet it comes from, and nolink leaves images without a link. While set, every such report uses it instead of its own link option; null lets each report use its own. One of nolink, rollstack, external.
  • llmProvider (string, required): The AI provider Rollstack tries first when it writes the organization's Insights, such as openai, azure_openai or amazon_bedrock; another provider may write them as a fallback. It isn't the custom LLM provider the slides agent runs on, which getLLMProvider returns. The API can't change it. custom_provider is a legacy value. One of openai, azure_openai, google_gemini, amazon_bedrock, google_ai_studio, google_vertex_ai, anthropic, custom_provider.
  • insightsEnabled (boolean, required): Whether the organization's reports can have Insights: AI-written commentary on the data in a report's visualizations. While off, no one can add or edit Insights, and runs leave existing ones unchanged.
  • memoriesEnabled (boolean, required): Whether members can use AI Memories: personal notes the AI draws on when it writes their Insights, such as to write large numbers with K, M or B. Each member keeps theirs, grouped in profiles, on the Insight Memories settings page, which is hidden while AI Memories are off.
  • spreadsheetsEnabled (boolean, required): Whether Rollstack offers Google Sheets and Microsoft Excel spreadsheets as data sources. While off, the app no longer offers them when someone adds a data source. Only the app checks this setting.
  • emailAnalyticsEnabled (boolean, required): Whether Rollstack can track when report emails are opened. While on, a report's emails are tracked once its email settings turn email analytics on (emailAnalyticsEnabled). While off, no report email is tracked, whatever its settings say.