Cube Company Groups API
The Company Groups API from Cube — 4 operation(s) for company groups.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cubesoftware-company-groups-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Cube Company Groups API
version: 1.0.0 (1.0)
description: '#### General Description
An API to access underlying Cube functionality.'
termsOfService: https://www.cubesoftware.com/terms-of-service
servers:
- url: https://api.cubesoftware.com
description: Production API URL
tags:
- name: Company Groups
paths:
/company/groups:
get:
operationId: company_groups_list
description: Lists all of the groups for the current user's company
summary: List a company's groups
parameters:
- in: header
name: X-Company-ID
schema:
type: string
description: Associates request with company
required: true
tags:
- Company Groups
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CompanyGroup'
description: ''
post:
operationId: company_groups_create
description: Create a new group for the current user's company
summary: Create a group
parameters:
- in: header
name: X-Company-ID
schema:
type: string
description: Associates request with company
required: true
tags:
- Company Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGroup'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CompanyGroup'
multipart/form-data:
schema:
$ref: '#/components/schemas/CompanyGroup'
required: true
security:
- OAuth2: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGroup'
description: ''
/company/groups/{company_group_pk}/subcube-access-rules:
get:
operationId: company_groups_subcube_access_rules_list
description: Default authenticated ViewSet with standard rate limit (DEFAULT_API_RATE_LIMIT).
parameters:
- in: path
name: company_group_pk
schema:
type: string
required: true
tags:
- Company Groups
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SubcubeAccessRule'
description: ''
summary: Company groups subcube access rules list
x-summary-source: derived
post:
operationId: company_groups_subcube_access_rules_create
description: Default authenticated ViewSet with standard rate limit (DEFAULT_API_RATE_LIMIT).
parameters:
- in: path
name: company_group_pk
schema:
type: string
required: true
tags:
- Company Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
multipart/form-data:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
required: true
security:
- OAuth2: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
description: ''
summary: Company groups subcube access rules create
x-summary-source: derived
/company/groups/{company_group_pk}/subcube-access-rules/{id}:
get:
operationId: company_groups_subcube_access_rules_retrieve
description: Default authenticated ViewSet with standard rate limit (DEFAULT_API_RATE_LIMIT).
parameters:
- in: path
name: company_group_pk
schema:
type: string
required: true
- in: path
name: id
schema:
type: string
required: true
tags:
- Company Groups
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
description: ''
summary: Company groups subcube access rules retrieve
x-summary-source: derived
put:
operationId: company_groups_subcube_access_rules_update
description: Default authenticated ViewSet with standard rate limit (DEFAULT_API_RATE_LIMIT).
parameters:
- in: path
name: company_group_pk
schema:
type: string
required: true
- in: path
name: id
schema:
type: string
required: true
tags:
- Company Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
multipart/form-data:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
required: true
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
description: ''
summary: Company groups subcube access rules update
x-summary-source: derived
patch:
operationId: company_groups_subcube_access_rules_partial_update
description: Default authenticated ViewSet with standard rate limit (DEFAULT_API_RATE_LIMIT).
parameters:
- in: path
name: company_group_pk
schema:
type: string
required: true
- in: path
name: id
schema:
type: string
required: true
tags:
- Company Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSubcubeAccessRule'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSubcubeAccessRule'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSubcubeAccessRule'
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubcubeAccessRule'
description: ''
summary: Company groups subcube access rules partial update
x-summary-source: derived
delete:
operationId: company_groups_subcube_access_rules_destroy
description: Default authenticated ViewSet with standard rate limit (DEFAULT_API_RATE_LIMIT).
parameters:
- in: path
name: company_group_pk
schema:
type: string
required: true
- in: path
name: id
schema:
type: string
required: true
tags:
- Company Groups
security:
- OAuth2: []
responses:
'204':
description: No response body
summary: Company groups subcube access rules destroy
x-summary-source: derived
/company/groups/{id}:
get:
operationId: company_groups_retrieve
description: Retrieve a group for the company by its group ID
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:
- Company Groups
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGroup'
description: ''
summary: Company groups retrieve
x-summary-source: derived
put:
operationId: company_groups_update
description: Update a group for the current user's company
summary: Update a group
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:
- Company Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGroupOpenApiDoc_1'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CompanyGroupOpenApiDoc_1'
multipart/form-data:
schema:
$ref: '#/components/schemas/CompanyGroupOpenApiDoc_1'
required: true
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGroup'
description: ''
patch:
operationId: company_groups_partial_update
description: Update a group for the current user's company
summary: Update a subset of a group's fields
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:
- Company Groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCompanyGroupOpenApiDoc_2'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCompanyGroupOpenApiDoc_2'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCompanyGroupOpenApiDoc_2'
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyGroup'
description: ''
delete:
operationId: company_groups_destroy
description: Delete a group for the current user's company
summary: Delete a group
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:
- Company Groups
security:
- OAuth2: []
responses:
'204':
description: No response body
components:
schemas:
CompanyGroupOpenApiDoc_1:
type: object
properties:
user_invitations:
type: string
user_companies:
type: string
permissions:
type: string
permissionsets:
type: string
subcube_access_rules:
type: array
items:
$ref: '#/components/schemas/SubcubeAccessRule'
name:
type: string
maxLength: 100
active:
type: boolean
required:
- name
CompanyGroupTypeEnum:
enum:
- feature
- dimension
type: string
description: '* `feature` - Feature
* `dimension` - Data'
PatchedSubcubeAccessRule:
type: object
description: 'This mixin is used to supplement the serializer with additional fields that are not provided in the request data
for use in updating either the model being worked with OR any through tables that are used to join the model with
a related model when the through table holds useful information.'
properties:
id:
type: integer
readOnly: true
company:
type: string
format: uuid
company_group:
type: integer
dimensions:
type: string
write_access:
type: boolean
created_by:
type: integer
created_at:
type: string
format: date-time
readOnly: true
modified_by:
type:
- integer
- 'null'
modified_at:
type: string
format: date-time
readOnly: true
CompanyGroup:
type: object
description: 'This mixin is used to supplement the serializer with additional fields that are not provided in the request data
for use in updating either the model being worked with OR any through tables that are used to join the model with
a related model when the through table holds useful information.'
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 100
company:
type: string
format: uuid
type:
allOf:
- $ref: '#/components/schemas/CompanyGroupTypeEnum'
default: feature
active:
type: boolean
user_companies:
type: string
user_invitations:
type: string
created_by:
type:
- integer
- 'null'
created_at:
type: string
format: date-time
readOnly: true
permissions:
type: string
permissionsets:
type: string
subcube_access_rules:
type: array
items:
$ref: '#/components/schemas/SubcubeAccessRule'
resolved_permissions:
type: array
items:
type: integer
readOnly: true
resolved_permissionsets:
type: array
items:
type: integer
readOnly: true
editable:
type: boolean
readOnly: true
required:
- company
- created_at
- editable
- id
- name
- resolved_permissions
- resolved_permissionsets
SubcubeAccessRule:
type: object
description: 'This mixin is used to supplement the serializer with additional fields that are not provided in the request data
for use in updating either the model being worked with OR any through tables that are used to join the model with
a related model when the through table holds useful information.'
properties:
id:
type: integer
readOnly: true
company:
type: string
format: uuid
company_group:
type: integer
dimensions:
type: string
write_access:
type: boolean
created_by:
type: integer
created_at:
type: string
format: date-time
readOnly: true
modified_by:
type:
- integer
- 'null'
modified_at:
type: string
format: date-time
readOnly: true
required:
- company
- company_group
- created_at
- created_by
- id
- modified_at
PatchedCompanyGroupOpenApiDoc_2:
type: object
properties:
user_invitations:
type: string
user_companies:
type: string
permissions:
type: string
permissionsets:
type: string
subcube_access_rules:
type: array
items:
$ref: '#/components/schemas/SubcubeAccessRule'
name:
type: string
maxLength: 100
active:
type: boolean
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