How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cube Planning User API

User endpoints allow for various functionality tied to users.

Cube Planning User API is one of 42 APIs that Cube Planning publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 8 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0 (1.0).

Requests are made against a single base URL, https://api.cubesoftware.com.

8 operations 7 paths 16 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0 (1.0)
Base URL
https://api.cubesoftware.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Cube Planning User API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow.

  • OAuth2 — Standard Cube OAuth 2.0 flow

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

User 8

User endpoints allow for various functionality tied to users.

GET
/user
Will return user information.
user_retrieve 1 param → 200
GET
/user/companies
Get User's Companies
user_companies_retrieve 1 param → 200
GET
/user/company/settings
Get User Company Settings
user_company_settings_retrieve 1 param → 200
POST
/user/company/settings
Update User Company Settings
user_company_settings_create 1 param body → 200
POST
/user/password/forgot
Initiates the forgot password process.
user_password_forgot_create 1 param body → 200
GET
/user/settings/spreadsheets
Get Spreadsheet Settings
user_settings_spreadsheets_retrieve 1 param → 200
POST
/user/settings/spreadsheets/update
Update Spreadsheet Settings
user_settings_spreadsheets_update_create 1 param body → 200
GET
/user/user_companies
Get User's Companies with Permissions
user_user_companies_retrieve 1 param → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are User (9 properties), Company (6 properties), AuthGroupPermissions (2 properties), UserCompanySettingsResponse (2 properties). Each schema is shown below with its type and property counts.

UserCompanyViewResponse
object
2 properties 2 required
TimeTypeEnum
string
STANDARD - Standard HALFYEAR - Half Year CUSTOM - Custom
RelationshipTypeEnum
string
EMPLOYEE - Employee PARTNER - Partner
UserCompanySettingsRequest
object
1 property 1 required
NullEnum
UserSpreadsheetUpdateRequest
object
1 property 1 required
Message_Response
object
1 property 1 required
forgot_password_message_serializer_message_serializer
object
1 property 1 required
UserSpreadsheetSettingsResponse
object
2 properties 2 required
BlankEnum
ForgotPasswordOpenApiDocAttributes_1
object
1 property 1 required
UserCompanySettingsResponse
object
2 properties 2 required
Company
object
A serializer mixin that allows dynamic inclusion or exclusion of serializer fields by passing fields=[...] or excludefields=[...] when initializing.
6 properties 4 required
AuthGroupPermissions
object
2 properties 2 required
TimezoneEnum
string
Africa/Abidjan - Africa/Abidjan Africa/Accra - Africa/Accra Africa/AddisAbaba - Africa/AddisAbaba Africa/Algiers - Africa/Algiers Africa/Asmara - Africa/Asmara…
User
object
A serializer mixin that allows dynamic inclusion or exclusion of serializer fields by passing fields=[...] or excludefields=[...] when initializing.
9 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cube-planning-user-api-openapi.yml Raw ↑

Other APIs Cube Planning publishes across the network.

Cube Planning Agents API
Cube Planning Attributes API
Cube Planning Audit Trail API
Cube Planning Auth API
Cube Planning Authentication API
Cube Planning Canvases API
Cube Planning ChatMessages API
Cube Planning ChatSessions API
Cube Planning ChatSettings API
Cube Planning Comments API
Cube Planning Companies API
Cube Planning Company Groups API
Where this information came from

This is an independent, third-party profile of Cube Planning User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.