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 Audit Trail API

The Audit Trail API from RingCentral — 1 operation(s) for audit trail.

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

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

This API exposes 1 operation across 1 path, and defines 12 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.

1 operations 1 paths 12 schemas 1 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 Audit Trail 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Audit Trail 1
POST
/restapi/v1.0/account/{accountId}/audit-trail/search
Search Audit Trail Data
auditTrailSearch 1 param body → 200400403404500503

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AccountHistoryPublicRecord (11 properties), AccountHistorySearchPublicRequest (10 properties), AccountHistoryRecordTarget (5 properties), AccountHistoryPaging (4 properties). Each schema is shown below with its type and property counts.

AccountHistoryRecordTarget
object
Action target object (company/extension)
5 properties
AccountHistoryRecordDetailsParameters
object
2 properties 2 required
AccountHistoryPaging
object
4 properties
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
AccountHistoryRecordPublicInitiator
object
Event initiator info
4 properties
AccountHistoryPublicRecord
object
11 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
AccountHistoryRecordPublicDetails
object
1 property
AccountHistorySearchPublicRequest
object
10 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…
AccountHistorySearchPublicResponse
object
2 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-audit-trail-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