RelativityOne

RelativityOne Entities API

Operations for managing HR entities and employees

Documentation GitHub OpenAPI

Operations 2

POST /relativity-environment/v1/workspaces/{workspaceId}/legal-hold/entities Create Entity #

PUT /relativity-environment/v1/workspaces/{workspaceId}/legal-hold/entities/{entityId} Update Entity Status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/relativityone:relativityone-entities-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: RelativityOne Legal Hold Entities API
  description: The Legal Hold API enables matter and project management integration with external systems such as matter management platforms and HR systems. It provides endpoints for custodian management, preservation workflows, task tracking, entity management, and communication configuration. Authentication is handled via Microsoft Graph API.
  version: 1.0.0
  contact:
    url: https://platform.relativity.com/
  license:
    name: Proprietary
    url: https://www.relativity.com/terms-of-service/
servers:
- url: https://relativity.rest/api
  description: RelativityOne REST API
security:
- BearerAuth: []
tags:
- name: Entities
  description: Operations for managing HR entities and employees
paths:
  /relativity-environment/v1/workspaces/{workspaceId}/legal-hold/entities:
    post:
      operationId: createEntity
      summary: Create Entity
      description: Creates an HR entity with name and email for use in legal hold workflows.
      tags:
      - Entities
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The artifact ID of the workspace.
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEntityRequest'
      responses:
        '200':
          description: Entity created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entity'
  /relativity-environment/v1/workspaces/{workspaceId}/legal-hold/entities/{entityId}:
    put:
      operationId: updateEntityStatus
      summary: Update Entity Status
      description: Updates the employee status of an entity.
      tags:
      - Entities
      parameters:
      - name: workspaceId
        in: path
        required: true
        description: The artifact ID of the workspace.
        schema:
          type: integer
      - name: entityId
        in: path
        required: true
        description: The artifact ID of the entity.
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEntityStatusRequest'
      responses:
        '200':
          description: Entity status updated successfully.
components:
  schemas:
    UpdateEntityStatusRequest:
      type: object
      required:
      - employeeStatus
      properties:
        employeeStatus:
          type: string
          description: The updated employment status.
    CreateEntityRequest:
      type: object
      required:
      - firstName
      - lastName
      - emailAddress
      properties:
        firstName:
          type: string
          description: First name of the entity.
        lastName:
          type: string
          description: Last name of the entity.
        emailAddress:
          type: string
          format: email
          description: Email address of the entity.
        employeeId:
          type: string
          description: Optional employee identifier.
    Entity:
      type: object
      properties:
        artifactId:
          type: integer
          description: The unique artifact ID of the entity.
        firstName:
          type: string
          description: First name of the entity.
        lastName:
          type: string
          description: Last name of the entity.
        emailAddress:
          type: string
          format: email
          description: Email address of the entity.
        employeeStatus:
          type: string
          description: Employment status of the entity.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained via Microsoft Graph API OAuth flow.