How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Relativity Legal Hold Module API

The Legal Hold Module API from Relativity — 14 operation(s) for legal hold module.

Relativity Legal Hold Module API is one of 52 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Legal Hold Module. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 14 operations across 14 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version V0.

Requests are made against a single base URL, /Relativity.REST/api.

14 operations 14 paths 21 schemas 13 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
V0
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 14

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

Legal Hold Module 14
GET
/CustodianPortalAuthUrl/GetPortalRedirectUrl
K cura legal hold services ICustodian portal auth url manager get portal…
kCura.LegalHold.Services.ICustodianPortalAuthUrlManager.GetPortalRedirectUrl 3 params → 200
GET
/custodian-request-manager/ActiveCustodianSummary
K cura legal hold services ICustodian request manager active custodian summary
kCura.LegalHold.Services.ICustodianRequestManager.ActiveCustodianSummary 4 params → 200
GET
/workspace/{workspaceId}/GetRedirectUriAsync
K cura legal hold services IGoogle authorization manager get redirect uri async
kCura.LegalHold.Services.IGoogleAuthorizationManager.GetRedirectUriAsync 3 params → 200
GET
/workspace/{workspaceId}/GoogleMail/HandleAuthenticationRedirect
K cura legal hold services IGoogle authorization manager process GSuite auth…
kCura.LegalHold.Services.IGoogleAuthorizationManager.ProcessGSuiteAuthRedirectAsync 5 params → 200
GET
/graph-auth-response
K cura legal hold services IGraph authorization manager authorize microsoft…
kCura.LegalHold.Services.IGraphAuthorizationManager.AuthorizeMicrosoftGraph 3 params → 200
GET
/authorized-user/{workspaceId}
K cura legal hold services IGraph authorization manager get authorized user
kCura.LegalHold.Services.IGraphAuthorizationManager.GetAuthorizedUser 2 params → 200
GET
/preservation/{projectArtifactId}/getCustodians
K cura legal hold services IPreservation manager get custodians async
kCura.LegalHold.Services.IPreservationManager.GetCustodiansAsync 5 params → 200
GET
/preservation/IsInstalled/{workspaceId}
K cura legal hold services IPreservation manager installed async
kCura.LegalHold.Services.IPreservationManager.InstalledAsync 2 params → 200
GET
/health-check
K cura legal hold services IPost deploy health check manager health check async
kCura.LegalHold.Services.IPostDeployHealthCheckManager.HealthCheckAsync 1 param → 200
GET
/toggles/{toggleName}/is-enabled
K cura legal hold services IToggle manager is enabled
kCura.LegalHold.Services.IToggleManager.IsEnabled 2 params → 200
GET
/SettingsManagement/workspace/{workspaceId}/ValidateEmailSettings
K cura legal hold services ISettings processor validate email settings
kCura.LegalHold.Services.ISettingsProcessor.ValidateEmailSettings 4 params → 200
GET
/workload-discovery/{guid}/workload
K cura legal hold services IWorkload discovery manager get agent workload async
kCura.LegalHold.Services.IWorkloadDiscoveryManager.GetAgentWorkloadAsync 2 params → 200
GET
/workspace/{workspaceArtifactId}/communication/{communicationArtifactId}/layout-state
K cura legal hold services ICommunication manager get communication layout state
kCura.LegalHold.Services.ICommunicationManager.GetCommunicationLayoutState 3 params → 200
POST
/workspace/{workspaceArtifactId}/communication/{communicationArtifactId}/acknowledge-on-behalf
K cura legal hold services ICommunication manager acknowledge on behalf
kCura.LegalHold.Services.ICommunicationManager.AcknowledgeOnBehalf 3 params body → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Uri (22 properties), ApplicationInstallSearchItem (13 properties), LegalHoldApplicationInstallResponse (10 properties), ActiveCustodianSummary (9 properties). Each schema is shown below with its type and property counts.

GenericMessageResponseModel
object
2 properties
InstallStatus
object
6 properties
Workload
object
1 property
ValidationSettings
object
2 properties
Version
object
6 properties
ArtifactIDCollection
object
3 properties
HttpResponseMessage
object
7 properties
AcknowledgeOnBehalfModel
object
2 properties
LegalHoldApplicationInstallResponse
object
10 properties
DisplayableObjectIdentifier
object
3 properties
Int16
object
Action
object
5 properties
HttpRequestMessage
object
6 properties
HttpContent
object
1 property
CommunicationLayoutStateModel
object
UrlRedirectModel
object
1 property
ActiveCustodianSummary
object
9 properties
ApplicationInstallSearchItem
object
13 properties
HttpMethod
object
8 properties
InstallStatusSummary
object
8 properties
Uri
object
22 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-legal-hold-module-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 API
Relativity ARM Module v3 API
Relativity BillableSummaryReports API
Relativity BillingConfiguration API
Relativity BillingInsights API
Relativity Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API
Where this information came from

This is an independent, third-party profile of Relativity Legal Hold Module API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.