openapi: 3.0.3 info: title: Cube Agents Library API version: 1.0.0 (1.0) description: "#### General Description\nAn API to access underlying Cube functionality. These endpoints are the same endpoints\nthat support Cube's universal add-ons and a plethora of integrations meaning you'll be able to interact with your\nCube data in many powerful ways. Visit the API section of Cube's [Help Center](https://help.cubesoftware.com/hc/en-us/sections/18205290556180-Custom-Integrations)\nfor more usage guides on how you can use this API to integrate with Cube to accomplish various tasks!\n\n#### Versioning\nAll requests to the API require a version to be configured via an `Accept` Header. The value of this Header should look like this:\n```\nAccept: application/json; version=1.0\n```\nNote that the version number may differ depending on which version of the endpoint is needed.\n\n#### Response Structure\nThe general response structure of Cube's API endpoints will contain a `\"data\"` and `\"metadata\"` root level key:\n```json\n{\n \"data\": { ... object data or list of objects ... },\n \"metadata\": {\n \"status\": 200,\n \"message\": \"Potential message with additional context\",\n \"error\": false,\n \"code\": \"\"\n }\n}\n```\n\n#### Rate Limiting\nAll endpoints have a rate limit configured, most of them default to 5/s.\nWhen the rate limit is encountered, a 429 HTTP code will be returned.\n\n#### Error Handling\nIn the event an error occurs, the response will typically look like this:\n```json\n{\n \"data\": {},\n \"metadata\": {\n \"status\": 400,\n \"message\": \"Some error message\",\n \"error\": true,\n \"code\": \"SOME_ERROR_CODE\"\n }\n}\n```\n" termsOfService: https://www.cubesoftware.com/terms-of-service servers: - url: https://api.cubesoftware.com description: Production API URL tags: - name: Library paths: /folders: get: operationId: folders_list description: List folders for the requesting company in the given namespace. Supports drill-in via `?parent_id=`. summary: List folders parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: query name: namespace schema: type: string enum: - LIBRARY description: Folder namespace to list / create under. Defaults to `LIBRARY` when omitted. - in: query name: parent_id schema: type: integer description: Parent folder id whose direct children should be listed. Omit to list root folders. tags: - Library security: - OAuth2: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Folder' description: '' post: operationId: folders_create description: 'This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets: - list() - retrieve() - create() - update() - partial_update() - destroy() If you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the appropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block requests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be generated more easily.' summary: Create a folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/Folder' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Folder' multipart/form-data: schema: $ref: '#/components/schemas/Folder' required: true security: - OAuth2: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Folder' description: '' /folders/{id}: get: operationId: folders_retrieve description: 'This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets: - list() - retrieve() - create() - update() - partial_update() - destroy() If you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the appropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block requests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be generated more easily.' summary: Retrieve a folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Folder' description: '' patch: operationId: folders_partial_update description: 'This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets: - list() - retrieve() - create() - update() - partial_update() - destroy() If you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the appropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block requests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be generated more easily.' summary: Update a folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFolder' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedFolder' multipart/form-data: schema: $ref: '#/components/schemas/PatchedFolder' security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Folder' description: '' delete: operationId: folders_destroy description: 'This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets: - list() - retrieve() - create() - update() - partial_update() - destroy() If you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the appropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block requests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be generated more easily.' summary: Delete a folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library security: - OAuth2: [] responses: '204': description: No response body /library: get: operationId: library_list description: 'Read-only unified listing of Library entries: folders, templates, and files. Each row carries a `type` discriminator (`folder`, `template`, or `file`) and the fields relevant to that kind. Folders are always pinned to the top of the page regardless of `?ordering=`. The listing is **shallow** -- use `?folder_id=` to drill into a folder. `file` covers both binary uploads and URL bookmarks (same underlying model).' parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: query name: created_by_id schema: type: integer description: Filter to entries created by the given user id. - in: query name: folder_id schema: type: integer description: Folder id to scope the listing to (drill-in). Omit to list the root context. - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: ordering schema: type: string description: 'Comma-separated sort tokens (prefix `-` for descending). Allowed: [''created_at'', ''created_by'', ''last_opened_at'', ''name'', ''sharing_scheme'']. Default: `-created_at`. Folders always pin at the top regardless of ordering.' - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: search schema: type: string description: Case-insensitive substring match on `name`, applied at SQL before pagination. - in: query name: type schema: type: string enum: - all - file - template description: 'Single value: `all` (default), `template`, or `file`. Narrows the non-folder kinds shown. **Folders are always included in the response regardless of this filter** -- use `?folder_id=` to scope inside a folder instead. `file` covers both binary uploads and URL bookmarks (they share the underlying `TemplateUpload` model).' tags: - Library security: - OAuth2: [] responses: '200': description: No response body /library-items: get: operationId: library_items_list description: List all library items summary: List library items parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true tags: - Library security: - OAuth2: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/LibraryItem' description: '' '401': description: Unauthorized '403': description: Forbidden. Request was valid, but you do not have necessary permissions. post: operationId: library_items_create description: Create a library item. Either file or url must be provided but not both. summary: Create a library item parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/LibraryItem' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/LibraryItem' multipart/form-data: schema: $ref: '#/components/schemas/LibraryItem' required: true security: - OAuth2: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/LibraryItem' description: '' '400': description: Bad request. Validation error. '401': description: Unauthorized '403': description: Forbidden. Request was valid, but you do not have necessary permissions. /library-items/{id}: get: operationId: library_items_retrieve description: Retrieve a library item by id summary: Retrieve a library item parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LibraryItem' description: '' '401': description: Unauthorized '403': description: Forbidden. Request was valid, but you do not have necessary permissions. '404': description: Library item not found patch: operationId: library_items_partial_update description: Update a library item. Cannot replace an existing file with a url or vice versa. Cannot set both file and url. summary: Update a library item parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedLibraryItem' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedLibraryItem' multipart/form-data: schema: $ref: '#/components/schemas/PatchedLibraryItem' security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LibraryItem' description: '' '400': description: Bad request. Cannot set both file and url, or cannot replace file with url (or vice versa). '401': description: Unauthorized '403': description: Forbidden. Request was valid, but you do not have necessary permissions. '404': description: Library item not found delete: operationId: library_items_destroy description: Delete a library item by id summary: Delete a library item parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library security: - OAuth2: [] responses: '204': description: Library item deleted successfully '401': description: Unauthorized '403': description: Forbidden. Request was valid, but you do not have necessary permissions. '404': description: Library item not found /library/owners: get: operationId: library_owners_list description: Distinct creators of Library entries visible to the requester. Backs the Library page Owner filter dropdown. Mirrors `/library` visibility (same `?folder_id=` / `?type=` scoping, same per-instance permission filter) so creators of rows the requester can't see never appear here. Not paginated -- owner counts are bounded by company size. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: query name: created_by_id schema: type: integer description: Filter to entries created by the given user id. - in: query name: folder_id schema: type: integer description: Folder id to scope the owner set to a specific folder. Omit to return owners of the root listing. Same semantics as `/library?folder_id=`. - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: ordering schema: type: string description: 'Comma-separated sort tokens (prefix `-` for descending). Allowed: [''created_at'', ''created_by'', ''last_opened_at'', ''name'', ''sharing_scheme'']. Default: `-created_at`. Folders always pin at the top regardless of ordering.' - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: search schema: type: string description: Case-insensitive substring match on `name`, applied at SQL before pagination. - in: query name: type schema: type: string enum: - all - file - template description: 'Single value: `all` (default), `template`, or `file`. Narrows the owner set to creators of items of those kinds. Folders are always considered, matching `/library`.' tags: - Library security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' /templates: get: operationId: templates_list description: 'List all templates available to the authenticated user company. - Expensive fields such as `content`, `styles`, `sheet_metadata`, `formulas`, `images`, etc are omitted from this response for performance reasons.' summary: List all templates. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: query name: planning_table_id schema: type: integer description: Limit results to those associated with this planning table id tags: - Library security: - OAuth2: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Template' examples: ListTemplates: value: - id: bdf7a8d3-3dcd-4fed-b13a-939d6b9b5a59 name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 cube_value_range: id: 2 filters: '6': 66 '7': 77 name: Range 11 fetch_enabled: true publish_enabled: true currency: id: 3 name: United States Dollar code: USD exclude_zeros: false table_datasets: - id: 11 address: D5:F7 planning_table_id: 1 scenario_id: 8 sharing_scheme: MANAGERS shared_with: [] created_by: id: 501 first_name: John last_name: Doe is_staff: true timezone: US/Eastern created_at: '2026-07-12T00:28:02.235809+00:00' modified_at: '2026-07-12T00:28:02.235872+00:00' folder: null last_opened_at: '2026-07-12T00:28:02.235896+00:00' summary: List Templates description: Successful retrieval of templates post: operationId: templates_create description: 'Create a new template. - When submitted fields contain A1 range values, these values will be normalized (shifted) relative to cell A1 before being stored. - Matrix fields such as `content`, `styles`, `sheet_metadata`, `formulas`, and `images` will be _sparsified_ for storage optimization, meaning their values will be stored as key-value pairs addressed by their cell references.' summary: Create a template. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/Template' examples: CreateATemplate: value: name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 table_datasets: - id: 11 address: D5:F7 content: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '12345' - June 13, 1982 - '' - '' - '' styles: - - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: - - '' - '' - '' - =SUM(A1:B4) - =SUM(A1:B5) - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - =DIV(A1:B4) - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' formats: - - '' - '' - '#,##0.00' - 0.00% - '' - '' - '' - - '' - '' - '' - '#,##0.00;(#,##0.00)' - '' - '' - '' - - '' - '' - mm/dd/yyyy - '' - '' - '' - '' - - '' - '' - '' - h:mm:ss am/pm - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - url: https://crystal.com/clear.png summary: Create a Template application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' multipart/form-data: schema: $ref: '#/components/schemas/Template' required: true security: - OAuth2: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Template' examples: TemplateCreated: value: id: 255f6070-53c0-48f1-991c-da59faa3a217 name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 cube_value_range: id: 2 filters: '6': 66 '7': 77 name: Range 11 fetch_enabled: true publish_enabled: true currency: id: 3 name: United States Dollar code: USD exclude_zeros: false headers: B1: Q1-25 A2: Revenue filters: '6': 66 '7': 77 table_datasets: - id: 11 address: D5:F7 planning_table_id: 1 scenario_id: 8 planning_table_schema: - id: 4e947903-9d1a-4523-b537-b90364972868 name: Column-A required: true type: text - id: 4bb32be6-3a05-4894-8278-166dd7685f47 name: Column-B required: false type: text content: C6: '12345' D6: June 13, 1982 styles: A1: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false G6: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: D1: =SUM(A1:B4) E1: =SUM(A1:B5) A3: =DIV(A1:B4) formats: C1: '#,##0.00' D1: 0.00% D2: '#,##0.00;(#,##0.00)' C3: mm/dd/yyyy D4: h:mm:ss am/pm data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: G6: url: https://crystal.com/clear.png sharing_scheme: MANAGERS shared_with: [] created_by: id: 501 first_name: John last_name: Doe is_staff: true timezone: US/Eastern created_at: '2026-07-12T00:28:02.238703+00:00' modified_at: '2026-07-12T00:28:02.238743+00:00' folder: null last_opened_at: '2026-07-12T00:28:02.238758+00:00' summary: Template Created description: '' /templates/{id}: get: operationId: templates_retrieve description: 'Fetch detailed information about a single template by ID. - Returns all template fields, including potentially large optional fields: `content`, `styles`, `sheet_metadata`, `formulas`, and `images`. - This endpoint is intended for detail views or editing.' summary: Retrieve a specific template. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' examples: RetrieveATemplate: value: id: fec9f913-27de-4d04-afb8-afd40a947ea3 name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 cube_value_range: id: 2 filters: '6': 66 '7': 77 name: Range 11 fetch_enabled: true publish_enabled: true currency: id: 3 name: United States Dollar code: USD exclude_zeros: false headers: B1: Q1-25 A2: Revenue filters: '6': 66 '7': 77 table_datasets: - id: 11 address: D5:F7 planning_table_id: 1 scenario_id: 8 planning_table_schema: - id: 6dfed068-50ea-4d67-884d-1c906c599122 name: Column-A required: true type: text - id: 18b9c04c-b65c-4531-82e6-d5718b386edd name: Column-B required: false type: text content: C6: '12345' D6: June 13, 1982 styles: A1: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false G6: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: D1: =SUM(A1:B4) E1: =SUM(A1:B5) A3: =DIV(A1:B4) formats: C1: '#,##0.00' D1: 0.00% D2: '#,##0.00;(#,##0.00)' C3: mm/dd/yyyy D4: h:mm:ss am/pm data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: G6: url: https://crystal.com/clear.png sharing_scheme: MANAGERS shared_with: [] created_by: id: 501 first_name: John last_name: Doe is_staff: true timezone: US/Eastern created_at: '2026-07-12T00:28:02.237307+00:00' modified_at: '2026-07-12T00:28:02.237352+00:00' folder: null last_opened_at: '2026-07-12T00:28:02.237367+00:00' summary: Retrieve a Template description: '' put: operationId: templates_update description: Update an existing template. summary: Update a template. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/Template' examples: UpdateATemplate: value: name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 table_datasets: - id: 11 address: D5:F7 content: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '12345' - June 13, 1982 - '' - '' - '' styles: - - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: - - '' - '' - '' - =SUM(A1:B4) - =SUM(A1:B5) - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - =DIV(A1:B4) - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' formats: - - '' - '' - '#,##0.00' - 0.00% - '' - '' - '' - - '' - '' - '' - '#,##0.00;(#,##0.00)' - '' - '' - '' - - '' - '' - mm/dd/yyyy - '' - '' - '' - '' - - '' - '' - '' - h:mm:ss am/pm - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - url: https://crystal.com/clear.png summary: Update a Template application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Template' examples: UpdateATemplate: value: name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 table_datasets: - id: 11 address: D5:F7 content: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '12345' - June 13, 1982 - '' - '' - '' styles: - - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: - - '' - '' - '' - =SUM(A1:B4) - =SUM(A1:B5) - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - =DIV(A1:B4) - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' formats: - - '' - '' - '#,##0.00' - 0.00% - '' - '' - '' - - '' - '' - '' - '#,##0.00;(#,##0.00)' - '' - '' - '' - - '' - '' - mm/dd/yyyy - '' - '' - '' - '' - - '' - '' - '' - h:mm:ss am/pm - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - url: https://crystal.com/clear.png summary: Update a Template multipart/form-data: schema: $ref: '#/components/schemas/Template' examples: UpdateATemplate: value: name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 table_datasets: - id: 11 address: D5:F7 content: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '12345' - June 13, 1982 - '' - '' - '' styles: - - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: - - '' - '' - '' - =SUM(A1:B4) - =SUM(A1:B5) - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - =DIV(A1:B4) - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' formats: - - '' - '' - '#,##0.00' - 0.00% - '' - '' - '' - - '' - '' - '' - '#,##0.00;(#,##0.00)' - '' - '' - '' - - '' - '' - mm/dd/yyyy - '' - '' - '' - '' - - '' - '' - '' - h:mm:ss am/pm - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - url: https://crystal.com/clear.png summary: Update a Template required: true security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' examples: UpdatedTemplate: value: id: 88bd3b1a-0bc6-4acb-8dfe-d73bd286e058 name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 cube_value_range: id: 2 filters: '6': 66 '7': 77 name: Range 11 fetch_enabled: true publish_enabled: true currency: id: 3 name: United States Dollar code: USD exclude_zeros: false headers: B1: Q1-25 A2: Revenue filters: '6': 66 '7': 77 table_datasets: - id: 11 address: D5:F7 planning_table_id: 1 scenario_id: 8 planning_table_schema: - id: ea0a574b-b34a-4fd7-9e94-b809a6a97aa3 name: Column-A required: true type: text - id: 14d4ccf5-9e53-4824-80d5-7f97604b449f name: Column-B required: false type: text content: C6: '12345' D6: June 13, 1982 styles: A1: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false G6: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: D1: =SUM(A1:B4) E1: =SUM(A1:B5) A3: =DIV(A1:B4) formats: C1: '#,##0.00' D1: 0.00% D2: '#,##0.00;(#,##0.00)' C3: mm/dd/yyyy D4: h:mm:ss am/pm data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: G6: url: https://crystal.com/clear.png sharing_scheme: MANAGERS shared_with: [] created_by: id: 501 first_name: John last_name: Doe is_staff: true timezone: US/Eastern created_at: '2026-07-12T00:28:02.241118+00:00' modified_at: '2026-07-12T00:28:02.241161+00:00' folder: null last_opened_at: '2026-07-12T00:28:02.241174+00:00' summary: Updated Template description: Successful update of a template description: '' '400': content: application/json: schema: $ref: '#/components/schemas/error_response_serializer' examples: InvalidMatrix-likeFieldDimensions: value: data: {} metadata: status: 400 error: true message: 'Matrix dimensions must match those of the ''content'' field: (4x6).' code: invalid summary: Invalid matrix-like field dimensions description: The payload contains matrix-like fields (e.g., `formulas`, `styles`) whose dimensions do not match those of the `content` field. All matrix-like fields must have the same number of rows and columns as `content`. description: '' patch: operationId: templates_partial_update description: Update one or more writable fields on an existing template. summary: Partially update a template. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTemplate' examples: PatchATemplate: value: name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description formulas: - - '' - '' - '' - =SUM(A1:B4) - =SUM(A1:B5) - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - =DIV(A1:B4) - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' summary: Patch a Template application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedTemplate' examples: PatchATemplate: value: name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description formulas: - - '' - '' - '' - =SUM(A1:B4) - =SUM(A1:B5) - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - =DIV(A1:B4) - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' summary: Patch a Template multipart/form-data: schema: $ref: '#/components/schemas/PatchedTemplate' examples: PatchATemplate: value: name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description formulas: - - '' - '' - '' - =SUM(A1:B4) - =SUM(A1:B5) - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - =DIV(A1:B4) - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' - - '' - '' - '' - '' - '' - '' - '' summary: Patch a Template security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Template' examples: UpdatedTemplate: value: id: 8b1cb9eb-fed0-4216-9a7c-238060bcbedc name: A Fabulous Template allow_web_publish: true address: A1:G6 description: A fabulous description ranges: - id: 22 address: C2:D4 cube_value_range: id: 2 filters: '6': 66 '7': 77 name: Range 11 fetch_enabled: true publish_enabled: true currency: id: 3 name: United States Dollar code: USD exclude_zeros: false headers: B1: Q1-25 A2: Revenue filters: '6': 66 '7': 77 table_datasets: - id: 11 address: D5:F7 planning_table_id: 1 scenario_id: 8 planning_table_schema: - id: 94a7acee-2a1d-4081-818e-523e736de229 name: Column-A required: true type: text - id: bce38f0b-20d1-43f9-a0b6-042bd89f78f8 name: Column-B required: false type: text content: C6: '12345' D6: June 13, 1982 styles: A1: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false G6: font_underline: false background_color: '#ffffff' font_italic: false font_color: '#000000' font_size: 10 vertical_alignment: bottom font_bold: false font_family: Arial font_line_through: false formulas: D1: =SUM(A1:B4) E1: =SUM(A1:B5) A3: =DIV(A1:B4) formats: C1: '#,##0.00' D1: 0.00% D2: '#,##0.00;(#,##0.00)' C3: mm/dd/yyyy D4: h:mm:ss am/pm data_validation: {} sheet_metadata: gridlines: true columns: A: visibility: true width: 100 G: visibility: true width: 100 rows: '1': visibility: true height: 21 '6': visibility: true height: 21 merged_cells: {} images: G6: url: https://crystal.com/clear.png sharing_scheme: MANAGERS shared_with: [] created_by: id: 501 first_name: John last_name: Doe is_staff: true timezone: US/Eastern created_at: '2026-07-12T00:28:02.243339+00:00' modified_at: '2026-07-12T00:28:02.243380+00:00' folder: null last_opened_at: '2026-07-12T00:28:02.243393+00:00' summary: Updated Template description: Successful update of a template description: '' '400': content: application/json: schema: $ref: '#/components/schemas/error_response_serializer' examples: InvalidMatrix-likeFieldDimensions: value: data: {} metadata: status: 400 error: true message: 'Matrix dimensions must match those of the ''content'' field: (4x6).' code: invalid summary: Invalid matrix-like field dimensions description: The payload contains matrix-like fields (e.g., `formulas`, `styles`) whose dimensions do not match those of the `content` field. All matrix-like fields must have the same number of rows and columns as `content`. description: '' delete: operationId: templates_destroy description: Permanently removes a template by ID. summary: Delete a template. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library security: - OAuth2: [] responses: '204': description: No response body /templates/{id}/images/presign: post: operationId: templates_images_presign_create description: Return a pre-signed S3 URL for uploading an image linked to this template. Enable direct upload from the frontend. summary: Request a URL to upload a template image. parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: id schema: type: string required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplatePresignImageUploadRequest' examples: RequestAURLForAnImageUpload.: value: file_name: example_image.png file_type: image/png summary: Request a URL for an image upload. application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TemplatePresignImageUploadRequest' examples: RequestAURLForAnImageUpload.: value: file_name: example_image.png file_type: image/png summary: Request a URL for an image upload. multipart/form-data: schema: $ref: '#/components/schemas/TemplatePresignImageUploadRequest' examples: RequestAURLForAnImageUpload.: value: file_name: example_image.png file_type: image/png summary: Request a URL for an image upload. required: true security: - OAuth2: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TemplatePresignImageUploadRequest' examples: SuccessfulResponse: value: upload_url: https://example-s3-url.com/.../signature file_path: template-images/company_slug/template_123/example_image.png summary: Successful Response description: Successful response with a pre-signed S3 URL and the file path. '400': content: application/json: schema: $ref: '#/components/schemas/error_response_serializer' examples: MissingFileName: value: data: {} metadata: status: 400 error: true message: file_name: - File name is required. code: '' summary: Example of an error when the file name is missing. InvalidFileType: value: data: {} metadata: status: 400 error: true message: file_type: - 'Invalid file type. Allowed types are: image/jpeg, image/png.' code: '' summary: Example of an error when an invalid file type is provided. description: Validation error messages for invalid requests. /templates/data/update: post: operationId: templates_data_update_create description: Atomic Template Update parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true tags: - Library security: - OAuth2: [] - {} responses: '201': description: No response body /templates/folders: get: operationId: FolderList description: This endpoint retrieves all template folders summary: Get All Template Folders parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true tags: - Library security: - OAuth2: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FoldersGetResponse' description: '' post: operationId: FolderCreate description: This endpoint creates a new template folder summary: Create a New Template Folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/FolderCreateRequest' examples: Create/UpdateFolderName: value: name: Budget Process1 summary: Create / Update Folder Name application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FolderCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/FolderCreateRequest' required: true security: - OAuth2: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FolderCreateResponse' description: '' /templates/folders/{folder_id}: get: operationId: FolderRetrieve description: This endpoint retrieves a specific template folder summary: Get a Specific Template Folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: folder_id schema: type: integer description: ID of the folder to retrieve required: true examples: SampleValue: value: 1 summary: Sample value tags: - Library security: - OAuth2: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FolderGetResponse' description: '' post: operationId: FolderUpdate description: This endpoint updates a template folder summary: Update a Specific Template Folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: folder_id schema: type: integer description: ID of the folder to retrieve required: true examples: SampleValue: value: 1 summary: Sample value tags: - Library requestBody: content: application/json: schema: $ref: '#/components/schemas/FolderUpdateRequest' examples: Create/UpdateFolderName: value: name: Budget Process1 summary: Create / Update Folder Name application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/FolderUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/FolderUpdateRequest' required: true security: - OAuth2: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FolderUpdateResponse' description: '' delete: operationId: FolderUpdateDelete description: This endpoint deletes a template folder summary: Delete a Specific Template Folder parameters: - in: header name: X-Company-ID schema: type: string description: Associates request with company required: true - in: path name: folder_id schema: type: integer description: ID of the folder to retrieve required: true examples: SampleValue: value: 1 summary: Sample value tags: - Library security: - OAuth2: [] deprecated: true responses: '200': description: No response body '400': description: No response body '404': description: No response body components: schemas: FoldersGetResponse: type: object properties: id: type: integer name: type: string created_at: type: string format: date-time created_by: $ref: '#/components/schemas/User' modified_at: type: string format: date-time template_count: type: integer required: - created_at - created_by - id - modified_at - name - template_count error_response_serializer: type: object properties: data: type: object additionalProperties: {} metadata: $ref: '#/components/schemas/metadata_serializer' required: - data - metadata Folder: type: object description: Mixin to delegate create and update operations to a service class. properties: id: type: integer readOnly: true name: type: string maxLength: 255 company_id: type: string format: uuid readOnly: true namespace: allOf: - $ref: '#/components/schemas/NamespaceEnum' default: LIBRARY parent_id: type: integer nullable: true sharing_scheme: type: string default: MANAGERS shared_with: type: array items: type: string nullable: true created_by: allOf: - $ref: '#/components/schemas/User' readOnly: true created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true item_count: type: integer readOnly: true required: - company_id - created_at - created_by - id - item_count - modified_at - name Template: type: object description: Mixin to delegate create and update operations to a service class. properties: id: type: string format: uuid readOnly: true name: type: string maxLength: 255 allow_web_publish: type: boolean address: type: string description: type: string nullable: true ranges: type: array items: $ref: '#/components/schemas/TemplateCubeValueRange' table_datasets: type: array items: $ref: '#/components/schemas/TemplatePlanningTableDataset' content: {} styles: {} formulas: {} formats: {} data_validation: {} sheet_metadata: {} merged_cells: {} images: {} sharing_scheme: type: string default: MANAGERS shared_with: type: array items: type: string nullable: true created_by: allOf: - $ref: '#/components/schemas/User' readOnly: true created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true folder: type: integer nullable: true last_opened_at: type: string nullable: true readOnly: true required: - address - content - created_at - created_by - id - last_opened_at - modified_at - name NullEnum: enum: - null CurrencyNested: type: object properties: id: type: integer readOnly: true name: type: string readOnly: true code: type: string maxLength: 10 required: - code - id - name LibraryItem: type: object description: Mixin to delegate create and update operations to a service class. properties: id: type: string format: uuid readOnly: true name: type: string maxLength: 255 url: type: string format: uri nullable: true maxLength: 255 file: type: string format: uri nullable: true folder_id: type: integer nullable: true sharing_scheme: type: string default: MANAGERS shared_with: type: array items: type: string nullable: true created_by: type: integer readOnly: true company_id: type: string format: uuid readOnly: true created_at: type: string format: date-time readOnly: true required: - company_id - created_at - created_by - id - name PatchedTemplate: type: object description: Mixin to delegate create and update operations to a service class. properties: id: type: string format: uuid readOnly: true name: type: string maxLength: 255 allow_web_publish: type: boolean address: type: string description: type: string nullable: true ranges: type: array items: $ref: '#/components/schemas/TemplateCubeValueRange' table_datasets: type: array items: $ref: '#/components/schemas/TemplatePlanningTableDataset' content: {} styles: {} formulas: {} formats: {} data_validation: {} sheet_metadata: {} merged_cells: {} images: {} sharing_scheme: type: string default: MANAGERS shared_with: type: array items: type: string nullable: true created_by: allOf: - $ref: '#/components/schemas/User' readOnly: true created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true folder: type: integer nullable: true last_opened_at: type: string nullable: true readOnly: true A1CubeValueRange: type: object description: Mixin to delegate create and update operations to a service class. properties: id: type: integer readOnly: true headers: type: object additionalProperties: {} readOnly: true data: writeOnly: true nullable: true filters: {} range_type: $ref: '#/components/schemas/RangeTypeEnum' name: type: string nullable: true maxLength: 255 fetch_enabled: type: boolean publish_enabled: type: boolean row_discovery_enabled: type: boolean currency: $ref: '#/components/schemas/CurrencyNested' exclude_zeros: type: boolean suppressed_row_dimensions: {} created_by_id: type: integer nullable: true readOnly: true collapse_coordinates: type: array items: type: array items: type: integer maxItems: 2 minItems: 2 writeOnly: true expand_all_coordinates: type: array items: type: array items: type: integer maxItems: 2 minItems: 2 writeOnly: true expand_coordinates: type: array items: type: array items: type: integer maxItems: 2 minItems: 2 writeOnly: true tags: {} discovered_row_headers: type: object additionalProperties: {} readOnly: true delete: type: array items: type: string readOnly: true insert: type: object additionalProperties: type: array items: type: object additionalProperties: {} readOnly: true required: - created_by_id - delete - discovered_row_headers - filters - headers - id - insert RangeTypeEnum: enum: - PIVOT - DRILLDOWN type: string description: '* `PIVOT` - Pivot * `DRILLDOWN` - Drilldown' TimezoneEnum: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Coyhaique - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu type: string description: '* `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Asmera` - Africa/Asmera * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Timbuktu` - Africa/Timbuktu * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Atka` - America/Atka * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Buenos_Aires` - America/Buenos_Aires * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Catamarca` - America/Catamarca * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Coral_Harbour` - America/Coral_Harbour * `America/Cordoba` - America/Cordoba * `America/Costa_Rica` - America/Costa_Rica * `America/Coyhaique` - America/Coyhaique * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Ensenada` - America/Ensenada * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fort_Wayne` - America/Fort_Wayne * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Godthab` - America/Godthab * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Indianapolis` - America/Indianapolis * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Jujuy` - America/Jujuy * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Knox_IN` - America/Knox_IN * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Louisville` - America/Louisville * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Mendoza` - America/Mendoza * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montreal` - America/Montreal * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nipigon` - America/Nipigon * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Pangnirtung` - America/Pangnirtung * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Acre` - America/Porto_Acre * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rainy_River` - America/Rainy_River * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Rosario` - America/Rosario * `America/Santa_Isabel` - America/Santa_Isabel * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Shiprock` - America/Shiprock * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Thunder_Bay` - America/Thunder_Bay * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Virgin` - America/Virgin * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/South_Pole` - Antarctica/South_Pole * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Ashkhabad` - Asia/Ashkhabad * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Calcutta` - Asia/Calcutta * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Chongqing` - Asia/Chongqing * `Asia/Chungking` - Asia/Chungking * `Asia/Colombo` - Asia/Colombo * `Asia/Dacca` - Asia/Dacca * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Harbin` - Asia/Harbin * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Istanbul` - Asia/Istanbul * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kashgar` - Asia/Kashgar * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Katmandu` - Asia/Katmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macao` - Asia/Macao * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Rangoon` - Asia/Rangoon * `Asia/Riyadh` - Asia/Riyadh * `Asia/Saigon` - Asia/Saigon * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Tel_Aviv` - Asia/Tel_Aviv * `Asia/Thimbu` - Asia/Thimbu * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ujung_Pandang` - Asia/Ujung_Pandang * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Ulan_Bator` - Asia/Ulan_Bator * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faeroe` - Atlantic/Faeroe * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/ACT` - Australia/ACT * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Canberra` - Australia/Canberra * `Australia/Currie` - Australia/Currie * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/LHI` - Australia/LHI * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/NSW` - Australia/NSW * `Australia/North` - Australia/North * `Australia/Perth` - Australia/Perth * `Australia/Queensland` - Australia/Queensland * `Australia/South` - Australia/South * `Australia/Sydney` - Australia/Sydney * `Australia/Tasmania` - Australia/Tasmania * `Australia/Victoria` - Australia/Victoria * `Australia/West` - Australia/West * `Australia/Yancowinna` - Australia/Yancowinna * `Brazil/Acre` - Brazil/Acre * `Brazil/DeNoronha` - Brazil/DeNoronha * `Brazil/East` - Brazil/East * `Brazil/West` - Brazil/West * `CET` - CET * `CST6CDT` - CST6CDT * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Canada/Saskatchewan` - Canada/Saskatchewan * `Canada/Yukon` - Canada/Yukon * `Chile/Continental` - Chile/Continental * `Chile/EasterIsland` - Chile/EasterIsland * `Cuba` - Cuba * `EET` - EET * `EST` - EST * `EST5EDT` - EST5EDT * `Egypt` - Egypt * `Eire` - Eire * `Etc/GMT` - Etc/GMT * `Etc/GMT+0` - Etc/GMT+0 * `Etc/GMT+1` - Etc/GMT+1 * `Etc/GMT+10` - Etc/GMT+10 * `Etc/GMT+11` - Etc/GMT+11 * `Etc/GMT+12` - Etc/GMT+12 * `Etc/GMT+2` - Etc/GMT+2 * `Etc/GMT+3` - Etc/GMT+3 * `Etc/GMT+4` - Etc/GMT+4 * `Etc/GMT+5` - Etc/GMT+5 * `Etc/GMT+6` - Etc/GMT+6 * `Etc/GMT+7` - Etc/GMT+7 * `Etc/GMT+8` - Etc/GMT+8 * `Etc/GMT+9` - Etc/GMT+9 * `Etc/GMT-0` - Etc/GMT-0 * `Etc/GMT-1` - Etc/GMT-1 * `Etc/GMT-10` - Etc/GMT-10 * `Etc/GMT-11` - Etc/GMT-11 * `Etc/GMT-12` - Etc/GMT-12 * `Etc/GMT-13` - Etc/GMT-13 * `Etc/GMT-14` - Etc/GMT-14 * `Etc/GMT-2` - Etc/GMT-2 * `Etc/GMT-3` - Etc/GMT-3 * `Etc/GMT-4` - Etc/GMT-4 * `Etc/GMT-5` - Etc/GMT-5 * `Etc/GMT-6` - Etc/GMT-6 * `Etc/GMT-7` - Etc/GMT-7 * `Etc/GMT-8` - Etc/GMT-8 * `Etc/GMT-9` - Etc/GMT-9 * `Etc/GMT0` - Etc/GMT0 * `Etc/Greenwich` - Etc/Greenwich * `Etc/UCT` - Etc/UCT * `Etc/UTC` - Etc/UTC * `Etc/Universal` - Etc/Universal * `Etc/Zulu` - Etc/Zulu * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belfast` - Europe/Belfast * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kiev` - Europe/Kiev * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Nicosia` - Europe/Nicosia * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Tiraspol` - Europe/Tiraspol * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Uzhgorod` - Europe/Uzhgorod * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zaporozhye` - Europe/Zaporozhye * `Europe/Zurich` - Europe/Zurich * `GB` - GB * `GB-Eire` - GB-Eire * `GMT` - GMT * `GMT+0` - GMT+0 * `GMT-0` - GMT-0 * `GMT0` - GMT0 * `Greenwich` - Greenwich * `HST` - HST * `Hongkong` - Hongkong * `Iceland` - Iceland * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Iran` - Iran * `Israel` - Israel * `Jamaica` - Jamaica * `Japan` - Japan * `Kwajalein` - Kwajalein * `Libya` - Libya * `MET` - MET * `MST` - MST * `MST7MDT` - MST7MDT * `Mexico/BajaNorte` - Mexico/BajaNorte * `Mexico/BajaSur` - Mexico/BajaSur * `Mexico/General` - Mexico/General * `NZ` - NZ * `NZ-CHAT` - NZ-CHAT * `Navajo` - Navajo * `PRC` - PRC * `PST8PDT` - PST8PDT * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Enderbury` - Pacific/Enderbury * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Johnston` - Pacific/Johnston * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Ponape` - Pacific/Ponape * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Samoa` - Pacific/Samoa * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Truk` - Pacific/Truk * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `Pacific/Yap` - Pacific/Yap * `Poland` - Poland * `Portugal` - Portugal * `ROC` - ROC * `ROK` - ROK * `Singapore` - Singapore * `Turkey` - Turkey * `UCT` - UCT * `US/Alaska` - US/Alaska * `US/Aleutian` - US/Aleutian * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/East-Indiana` - US/East-Indiana * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Indiana-Starke` - US/Indiana-Starke * `US/Michigan` - US/Michigan * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `US/Samoa` - US/Samoa * `UTC` - UTC * `Universal` - Universal * `W-SU` - W-SU * `WET` - WET * `Zulu` - Zulu' TemplatePlanningTableDataset: type: object description: "A serializer that conditionally includes optional fields based on context.\n\nOptional fields should be listed in `Meta.read_optional_fields`. To include them\nin the output, pass a list via `context['include_fields']` (for top-level serializers)\nor `context[]['include_fields']` (for nested serializers).\n\nExamples:\n class ChildSerializer(IncludeOptionalFieldsSerializerMixin, serializers.ModelSerializer):\n extra = serializers.CharField()\n class Meta:\n model = Child\n fields = ['id', 'extra']\n read_optional_fields = ['extra']\n\n class ParentSerializer(IncludeOptionalFieldsSerializerMixin, serializers.ModelSerializer):\n child = ChildSerializer()\n expensive = serializers.CharField()\n class Meta:\n model = Parent\n fields = ['id', 'child', 'expensive']\n read_optional_fields = ['expensive']\n\n # Top-level usage (includes 'expensive' field)\n ParentSerializer(instance, context={'include_fields': ['expensive']}).data\n\n # Nested usage (includes 'extra' field inside child)\n ParentSerializer(\n instance,\n context={'child': {'include_fields': ['extra']}}\n ).data" properties: id: type: integer address: type: string planning_table_id: type: integer readOnly: true scenario_id: type: integer readOnly: true planning_table_schema: readOnly: true required: - address - id - planning_table_id - planning_table_schema - scenario_id TemplatePresignImageUploadRequest: type: object properties: file_name: type: string file_type: type: string required: - file_name - file_type PaginatedUserList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/User' FolderUpdateRequest: type: object properties: name: type: string required: - name FolderGetResponse: type: object properties: id: type: integer name: type: string created_at: type: string format: date-time created_by: $ref: '#/components/schemas/User' modified_at: type: string format: date-time template_count: type: integer required: - created_at - created_by - id - modified_at - name - template_count TemplateCubeValueRange: type: object description: "A serializer that conditionally includes optional fields based on context.\n\nOptional fields should be listed in `Meta.read_optional_fields`. To include them\nin the output, pass a list via `context['include_fields']` (for top-level serializers)\nor `context[]['include_fields']` (for nested serializers).\n\nExamples:\n class ChildSerializer(IncludeOptionalFieldsSerializerMixin, serializers.ModelSerializer):\n extra = serializers.CharField()\n class Meta:\n model = Child\n fields = ['id', 'extra']\n read_optional_fields = ['extra']\n\n class ParentSerializer(IncludeOptionalFieldsSerializerMixin, serializers.ModelSerializer):\n child = ChildSerializer()\n expensive = serializers.CharField()\n class Meta:\n model = Parent\n fields = ['id', 'child', 'expensive']\n read_optional_fields = ['expensive']\n\n # Top-level usage (includes 'expensive' field)\n ParentSerializer(instance, context={'include_fields': ['expensive']}).data\n\n # Nested usage (includes 'extra' field inside child)\n ParentSerializer(\n instance,\n context={'child': {'include_fields': ['extra']}}\n ).data" properties: id: type: integer address: type: string filters: readOnly: true deprecated: true headers: type: object additionalProperties: {} readOnly: true cube_value_range: allOf: - $ref: '#/components/schemas/A1CubeValueRange' readOnly: true required: - address - cube_value_range - filters - headers - id RelationshipTypeEnum: enum: - EMPLOYEE - PARTNER type: string description: '* `EMPLOYEE` - Employee * `PARTNER` - Partner' FolderCreateRequest: type: object properties: name: type: string required: - name User: type: object description: 'A serializer mixin that allows dynamic inclusion or exclusion of serializer fields by passing `fields=[...]` or `exclude_fields=[...]` when initializing.' properties: id: type: integer readOnly: true first_name: type: string maxLength: 100 last_name: type: string maxLength: 100 created_at: type: string format: date-time readOnly: true email: type: string format: email maxLength: 254 is_staff: type: boolean readOnly: true is_cube_staff: type: boolean readOnly: true relationship_type: nullable: true oneOf: - $ref: '#/components/schemas/RelationshipTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' timezone: $ref: '#/components/schemas/TimezoneEnum' required: - created_at - email - id - is_cube_staff - is_staff PatchedLibraryItem: type: object description: Mixin to delegate create and update operations to a service class. properties: id: type: string format: uuid readOnly: true name: type: string maxLength: 255 url: type: string format: uri nullable: true maxLength: 255 file: type: string format: uri nullable: true folder_id: type: integer nullable: true sharing_scheme: type: string default: MANAGERS shared_with: type: array items: type: string nullable: true created_by: type: integer readOnly: true company_id: type: string format: uuid readOnly: true created_at: type: string format: date-time readOnly: true metadata_serializer: type: object properties: status: type: integer error: type: boolean message: type: string code: type: string required: - code - error - message - status NamespaceEnum: enum: - LIBRARY type: string description: '* `LIBRARY` - Library' BlankEnum: enum: - '' PatchedFolder: type: object description: Mixin to delegate create and update operations to a service class. properties: id: type: integer readOnly: true name: type: string maxLength: 255 company_id: type: string format: uuid readOnly: true namespace: allOf: - $ref: '#/components/schemas/NamespaceEnum' default: LIBRARY parent_id: type: integer nullable: true sharing_scheme: type: string default: MANAGERS shared_with: type: array items: type: string nullable: true created_by: allOf: - $ref: '#/components/schemas/User' readOnly: true created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true item_count: type: integer readOnly: true FolderCreateResponse: type: object properties: id: type: integer name: type: string created_at: type: string format: date-time created_by: $ref: '#/components/schemas/User' modified_at: type: string format: date-time template_count: type: integer required: - created_at - created_by - id - modified_at - name - template_count FolderUpdateResponse: type: object properties: id: type: integer name: type: string created_at: type: string format: date-time created_by: $ref: '#/components/schemas/User' modified_at: type: string format: date-time template_count: type: integer required: - created_at - created_by - id - modified_at - name - template_count securitySchemes: OAuth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://portal.cubesoftware.com/o/authorize/ tokenUrl: https://api.cubesoftware.com/o/token/ scopes: {} description: Standard Cube OAuth 2.0 flow