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

RingCentral Company API

The Company API from RingCentral — 8 operation(s) for company.

RingCentral Company API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Company. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 8 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

9 operations 8 paths 52 schemas 6 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Company API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 6 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Company 9
GET
/restapi/v2/accounts/{accountId}
Get Account Info
getAccountInfoV2 1 param → 200403429404500503
POST
/restapi/v2/accounts/{accountId}/send-welcome-email
Send/Resend Welcome Email
sendWelcomeEmailV2 1 param body → 200400404500503
POST
/restapi/v2/accounts/{accountId}/send-activation-email
Send/Resend Activation Email
sendActivationEmailV2 1 param → 200400404500503
GET
/restapi/v1.0/account/{accountId}
Get Account Info
readAccountInfo 1 param → 200
GET
/restapi/v1.0/account/{accountId}/service-info
Get Account Service Info
readAccountServiceInfo 1 param → 200
GET
/restapi/v1.0/account/{accountId}/business-address
Get Account Business Address
readAccountBusinessAddress 1 param → 200
PUT
/restapi/v1.0/account/{accountId}/business-address
Update Company Business Address
updateAccountBusinessAddress 1 param body → 200
GET
/restapi/v1.0/dictionary/brand/{brandId}/contracted-country
List Contracted Countries
listContractedCountries 1 param → 200
GET
/restapi/v1.0/dictionary/brand/{brandId}/contracted-country/{contractedCountryId}
List Domestic Countries
listDomesticCountries 4 params → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are GetAccountInfoResponse (16 properties), AccountServiceInfoRequest (10 properties), AccountInfo (10 properties), AccountLimits (7 properties). Each schema is shown below with its type and property counts.

CountryListDictionaryModel
object
4 properties 3 required
BasicContactInfo
object
Personal contact information
3 properties
AccountServiceInfoRequest
object
Account service information, including brand, service plan and billing plan
10 properties
ServiceInfo
object
Account service information, including brand, sub-brand, service plan and billing plan
7 properties
ModifyAccountBusinessAddressRequest
object
4 properties
ServiceInfoCountryShortModel
BusinessAddressInfo
object
Company business address
5 properties
FormattingLocaleInfo
object
Formatting language preferences for numbers, dates and currencies
3 properties
SetupWizardStateEnum
string
Initial configuration wizard state
ServiceInfoPlan
object
Information on account service plan
4 properties
PhoneNumberE164
string
Phone number in e.164 format (with '+' prefix)
CountryInfoBasicModel
ServicePlanInfo
object
Information on account service plan
4 properties
AccountRegionalSettings
object
Account level region data (web service Auto-Receptionist settings)
7 properties
AccountLimits
object
Limits which are effective for the account
7 properties
AccountOperatorInfo
object
Operator extension information. This extension will receive all calls and messages addressed to an operator.
4 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
CountryInfoMinimalModel
object
2 properties
RegionalLanguageInfo
object
Information on a language set as regional
3 properties
PageNavigationUri
object
1 property
PostalAddress
object
Postal address/location
6 properties 4 required
PackageInfo
object
2 properties
AccountStatusInfo
object
Optional information to be used when account is moved to "Disabled" status
3 properties
ServiceFeatureInfo
object
2 properties
ServiceInfoPackage
object
Billing package information
2 properties 2 required
BillingPlanInfo
object
Information on account billing plan
6 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
UBrandInfo
object
Account sub-brand information
2 properties
BasicContactInfoWithPhone
AccountServiceInfo
CurrencyInfo
object
Currency information
5 properties
CountryInfoShortModel
BrandInfo
object
Information on account brand
3 properties
ContractedCountryListResponse
object
1 property 1 required
GreetingLanguageInfo
object
Information on language used for telephony greetings
3 properties
SignupInfoResource
object
Account sign up data
5 properties
ExtensionNumber
string
Short number of an extension. Actual max length depends on system length limit for extension.
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
GetAccountInfoResponse
object
16 properties
ServiceInfoV2
object
Service Plan information (billing package, brand, etc.)
5 properties 1 required
ServiceInfoBrand
object
Internal RC "brand" information
2 properties 2 required
EnumeratedPagingModel
object
6 properties 1 required
AccountBusinessAddressResource
object
5 properties
ContactBusinessAddressInfo
object
User's business address. The default is Company (Auto-Receptionist) settings
5 properties
PageNavigationModel
object
Links to other pages of the current result set
4 properties
CountryInfoDictionaryModel
AccountInfo
object
10 properties 3 required
TimezoneInfo
object
Extension timezone information
5 properties
ServiceInfoUBrand
object
Account sub-brand information
2 properties
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
TargetServicePlanInfo
object
Information on account target service plan
4 properties
SystemUserContactInfo
Primary system user contact information

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-company-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API
Where this information came from

This is an independent, third-party profile of RingCentral Company 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.