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