Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Company

Get Account Info

Returns basic information about a particular RingCentral customer account.

get/restapi/v1.0/account/{accountId}

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Response

Account information

idinteger

Internal identifier of an account

uristring uri

Canonical URI of an account

bsidstring

Internal identifier of an account in the billing system

mainNumberstring

Main phone number of the current account

partnerIdstring

Additional account identifier, created by partner application and applied on client side

setupWizardState'NotStarted' | 'Incomplete' | 'Completed' | 'Unknown'

Initial configuration wizard state

status'Initial' | 'Confirmed' | 'Unconfirmed' | 'Disabled'

Status of the current account

federatedboolean

Specifies whether an account is included into any federation of accounts or not

outboundCallPrefixinteger

If outbound call prefix is not specified, or set to null (0), then the parameter is not returned; the supported value range is 2-9

cfidstring

Customer facing identifier. Returned for accounts with the turned off PBX features. Equals to main company number in E.164 (without "+" sign)format

Example response

{
  "serviceInfo": {
    "uBrand": {
      "id": "111.222",
      "name": "Sub-brand name"
    }
  },
  "signupInfo": {
    "creationTime": "2023-03-10T18:07:52.534Z"
  },
  "statusInfo": {
    "reason": "CancelledVoluntarily",
    "comment": "By customer request. Case ABC123",
    "till": "2023-03-26T11:30:45.940Z"
  }
}