Get organization
- OpenAPI 3.1.0 document: https://api.rollstack.com/public/v1/openapi.json
- The whole reference in Markdown: https://docs.rollstack.com/llms-full.txt
- An index of the reference: https://docs.rollstack.com/llms.txt
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 sameidthatgetMereturns inorganization.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 withcreateReport, start with it as theirtimezone; changing it doesn't change thetimezoneof 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.nullmeans no default. An IANA timezone name, such asAmerica/New_York.allowedDomains(array of string or null, required): The organization's domain allowlist, such asacme.com: the email domains people can be invited to the organization from. While it is empty ornull, invites from the app aren't limited by domain, butcreateInvitesfails withinvites-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, soacme.comdoesn't covereu.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.updateupdates the same file with the latest data.archivefirst 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.updateVisualizationsis 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;nulllets each report use its own. One ofupdate,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.rollstackopens the visualization's page in Rollstack,externalopens the dashboard or spreadsheet it comes from, andnolinkleaves images without a link. While set, every such report uses it instead of its own link option;nulllets each report use its own. One ofnolink,rollstack,external.llmProvider(string, required): The AI provider Rollstack tries first when it writes the organization's Insights, such asopenai,azure_openaioramazon_bedrock; another provider may write them as a fallback. It isn't the custom LLM provider the slides agent runs on, whichgetLLMProviderreturns. The API can't change it.custom_provideris a legacy value. One ofopenai,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.