News & Announcements User Community Developer Community

Welcome to the RingCentral Community

Please note the community is currently under maintenance and is read-only.

Make sure to review our Terms of Use and Community Guidelines.
  Please note the community is currently under maintenance and is read-only.
Home » Developers
Please help me understand '~' in API calls
Tags: extension, rest api
Sep 18, 2023 at 12:47pm   •   2 replies  •  0 likes
Sreenivas Angara

Call1: { {baseUrl}}/restapi/v1.0/account/~/extension/~

Call2: { {baseUrl}}/restapi/v1.0/account/~/extension/

Please help me understand the significance of ~ in the API call.

Thank you

2 Answers
answered on Sep 19, 2023 at 9:31am  

Thank you for response.

There is an issue here and let's keep the focus on these two calls.

Call1: { {baseUrl}}/restapi/v1.0/account/~/extension/~

This call returns one entry business_address information with an id

Call2: { {baseUrl}}/restapi/v1.0/account/~/extension/

This call returns all the extensions for an account with an id

I am trying to build a fact_table that has all extensions, with business_address information. What is the best the way to build it. Please note, I cannot use id to join data between these two calls. The only way to do it, seems to parse the URI.

I think account_id is needed as part of the response. Please help

Thank you


on Sep 19, 2023 at 10:38am   •  0 likes

The "Call1" is for reading a particular extension info. This API gives you more detailed info of an extension.

The "Call2" is for listing all extensions under an account. This API gives you less detailed (basic) info of each extension under an account. The list API can be filtered by extension types as well.

Remember that in RingCentral, the "Account" term means "a company" and the "Extension" term (user extension) means "an employee".

So it's up to what info of an extension you want to read, then you can decide which API you should use. You can check the response from each API and decide which one to use. If you end up in using the read extension API (Call 1), then you have to call the list extensions API (Call 2) to grab all the extension ids (or part of them filtered by type) then use the extension id to read detailed info of that extension.

answered on Sep 18, 2023 at 1:59pm  

The tilde sign after the account (account/~) means the account id of the RingCentral account which the currently authenticated user belongs to.

The tilde sign after the extension (extension/~) means the extension id of the currently authenticated user.

So presumed that your account id is 610000011 and your extension id is 612002824, then


will be translated in RingCentral server as



A new Community is coming to RingCentral!

Posts are currently read-only as we transition into our new platform.

We thank you for your patience
during this downtime.

Try Workflow Builder

Did you know you can easily automate tasks like responding to SMS, team messages, and more? Plus it's included with RingCentral Video and RingEX plans!

Try RingCentral Workflow Builder

Developer Platform
Integrated Apps
App Gallery
Developer support
Games and rewards

Resource center
Product Releases
App Download
RingCentral App login
Admin Portal Login
Contact Sales
© 1999-2024 RingCentral, Inc. All rights reserved. Legal Privacy Notice Site Map Contact Us