Cube Invitations API
The Invitations API from Cube — 3 operation(s) for invitations.
The Invitations API from Cube — 3 operation(s) for invitations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/cubesoftware-invitations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Cube Invitations 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: Invitations
paths:
/company/invitations:
get:
operationId: company_invitations_list
description: Load all invitations for a company
summary: List invitations
parameters:
- in: header
name: X-Company-ID
schema:
type: string
description: Associates request with company
required: true
tags:
- Invitations
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserInvitation'
description: ''
post:
operationId: company_invitations_create
description: Invite someone to the company
summary: Create a new invitation
parameters:
- in: header
name: X-Company-ID
schema:
type: string
description: Associates request with company
required: true
tags:
- Invitations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitation'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UserInvitation'
multipart/form-data:
schema:
$ref: '#/components/schemas/UserInvitation'
required: true
security:
- OAuth2: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitation'
description: ''
/company/invitations/{id}:
get:
operationId: company_invitations_retrieve
description: Retrieves an invitation
summary: Retrieve an invitation
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:
- Invitations
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitation'
description: ''
put:
operationId: company_invitations_update
description: Update an invitation by sending all editable field data.
summary: Update an invitation
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:
- Invitations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitationUpdateOpenApiDocAttributes_1'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UserInvitationUpdateOpenApiDocAttributes_1'
multipart/form-data:
schema:
$ref: '#/components/schemas/UserInvitationUpdateOpenApiDocAttributes_1'
required: true
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitation'
description: ''
patch:
operationId: company_invitations_partial_update
description: Update one or more editable fields for an invitation.
summary: Partially update an invitation
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:
- Invitations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUserInvitationUpdateOpenApiDocAttributes_1'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedUserInvitationUpdateOpenApiDocAttributes_1'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedUserInvitationUpdateOpenApiDocAttributes_1'
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitation'
description: ''
delete:
operationId: company_invitations_destroy
description: Prevents a user from accepting the invitation.
summary: Deletes a invitation completely
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:
- Invitations
security:
- OAuth2: []
responses:
'204':
description: No response body
/company/invitations/{id}/resend:
put:
operationId: company_invitations_resend_update
description: Resends the email to the user. If the invitation has expired this will re-generate the invitation to reset the expiration date.
summary: Resend an invitation
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:
- Invitations
security:
- OAuth2: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserInvitation'
description: ''
components:
schemas:
UserInvitationUpdateOpenApiDocAttributes_1:
type: object
properties:
company_groups:
type: array
items:
type: integer
metadata: {}
permission_group:
type: integer
can_publish_data:
type: boolean
accepted_at:
type:
- string
- 'null'
format: date-time
required:
- company_groups
- permission_group
UserInvitation:
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: string
format: uuid
readOnly: true
email:
type: string
format: email
maxLength: 254
company:
type: string
format: uuid
permission_group:
type: integer
can_publish_data:
type: boolean
accepted_at:
type:
- string
- 'null'
format: date-time
created_by:
type: integer
created_at:
type: string
format: date-time
readOnly: true
last_sent:
type: string
format: date-time
readOnly: true
company_groups:
type: array
items:
type: integer
metadata: {}
expired:
type: boolean
readOnly: true
required:
- company
- company_groups
- created_at
- created_by
- email
- expired
- id
- last_sent
- permission_group
PatchedUserInvitationUpdateOpenApiDocAttributes_1:
type: object
properties:
company_groups:
type: array
items:
type: integer
metadata: {}
permission_group:
type: integer
can_publish_data:
type: boolean
accepted_at:
type:
- string
- 'null'
format: date-time
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