Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Internal Contacts API

The Internal Contacts API from RingCentral — 4 operation(s) for internal contacts.

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

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

This API exposes 4 operations across 4 paths, and defines 25 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.

4 operations 4 paths 25 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
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 Internal Contacts 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 4

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

Internal Contacts 4
GET
/restapi/v1.0/account/{accountId}/directory/entries
Get Company Directory Entries
listDirectoryEntries 8 params → 200400500503
GET
/restapi/v1.0/account/{accountId}/directory/entries/{entryId}
Get Corporate Directory Entry
readDirectoryEntry 2 params → 200400500503
POST
/restapi/v1.0/account/{accountId}/directory/entries/search
Search Company Directory Entries
searchDirectoryEntries 6 params body → 200400500503
GET
/restapi/v1.0/account/{accountId}/directory/federation
Get Account Federation
readDirectoryFederation 3 params → 200400500503

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ContactResource (22 properties), SearchDirectoryEntriesRequest (15 properties), PhoneNumberResource (7 properties), FederatedAccountResource (6 properties). Each schema is shown below with its type and property counts.

DirectoryRoleResource
object
4 properties 1 required
FederationType
string
Federation type
AccountDirectoryProfileImageResource
object
2 properties
BusinessSiteResource
object
3 properties
CostCenterResource
object
3 properties
ContactResource
object
22 properties 1 required
PhoneNumberResource
object
7 properties
SearchDirectoryExtensionTypes
array
Types of extension to filter the contacts
ExternalIntegrationResource
object
6 properties
EnumeratedPagingModel
object
6 properties 1 required
CustomFieldResource
object
3 properties
OrderBy
object
3 properties
CallQueueResource
object
2 properties
FederationTypes
string
Federation types for search
FederatedAccountResource
object
6 properties 1 required
GroupResource
object
2 properties
SearchDirectoryExtensionType
string
Type of extension to filter the contacts
ADGErrorResponse
object
Format of response in case that any error occurred during request processing
1 property
ADGError
object
Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed
2 properties
ContactSubTypeEnum
string
Extension subtype
AccountResource
object
4 properties 1 required
SearchDirectoryContactType
string
Type of directory contact to filter
FederationResource
object
6 properties
DirectoryResource
object
2 properties 2 required
SearchDirectoryEntriesRequest
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-internal-contacts-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