Client Manager (REST)

In Relativity, a client is a company or organization, which is associated with users, matters, groups, and workspaces. For general information, see Clients on the RelativityOne Documentation site.

The Client Manager service exposes endpoints that provide the following functionality:

  • CRUD operations on clients.
  • Helper endpoints for retrieving lists of available groups, matters, users, and statuses.
  • Endpoints for creating, submitting, and retrying client domain activation keys.

As a sample use case, you can programmatically create multiple clients by using the Client Manager service eliminating the need to manually add them through the Relativity UI.

You can also use the Client Manager service through .NET. For more information, see Client Manager (.NET).

This page contains the following information:

Guidelines for the Client Manager service

Review the following guidelines for working with this service.

URLs

The URLs for REST endpoints contain path parameters that you need to set before making a call:

  • Set {versionNumber} to the version of the API, using the format lowercase v and the version number, such as v1.
  • Set other path parameters in the URLs to the Artifact ID of a given entity, such as {workspaceID} to the Artifact ID of a workspace.
  • Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.

For example, you can use the following URL to retrieve a client:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}

Set the path parameters as follows:

  • {versionNumber} to the version of the API, such as v1.
  • {clientID} to the Artifact ID of a specific client.

Postman sample file

You can use the Postman sample file to become familiar with making calls to endpoints on the Client Manager service. To download the sample file, click Client Manager Postman file.

To get started with Postman, complete these steps:

  1. Obtain access to a Relativity environment. You need a username and password to make calls to your environment.
  2. Install Postman.
  3. Import the Postman sample file for the service. For more information, see Working with data files on the Postman web site.
  4. Select an endpoint. Update the URL with the domain for your Relativity environment and any other variables.
  5. In the Authorization tab, set the Type to Basic Auth, enter your Relativity credentials, and click Update Request.
  6. See the following sections on this page for more information on setting required fields for a request.
  7. Click Send to make a request.

Client code sample

To use the Client Manager service, send requests by making calls with the required HTTP methods. The following code sample illustrates how to make calls to the Client Manager service from a .NET client.

Create a client

To add a new client to Relativity, send a POST request with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/

Retrieve a client

You can retrieve basic information about a client or extended information, which also includes operations that you have permissions to perform on the client.

  • Retrieve basic metadata for a client - send a GET request to with a URL in the following format:
  • <host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}
  • Retrieve extended metadata for a client - send a GET request with a URL in the following format:
    <host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}?includeMetadata=true&includeActions=true

The request body is empty.

The response for a read operation contains the same fields as a response for a create operation. See the field descriptions in View field descriptions for a create response.

Update a client

You can modify the properties of a client. Additionally, you can also restrict the update of a client to the date that it was last modified by adding the LastModifiedOn field to the request body.

Send a PUT request to with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}

When the client is successfully updated, the response returns the status code of 200.

Delete a client

To remove a client from Relativity, send a DELETE request with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}

Note: Before deleting a client, consider checking for dependent clients using Object Manager service. See Object Manager (REST).

When the client is successfully deleted, the response returns the status code of 200.

Helper endpoints for CRUD operations

The following helper endpoints retrieve lists of available groups, matters, users, and statuses, which may be helpful when creating or updating clients. For general information, see Clients on the RelativityOne Documentation site.

Retrieve associated groups

To retrieve information about groups associated with a client, send a POST request with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}/query-groups

Retrieve associated matters

To retrieve information about the matters associated with a client, send a POST request with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}/query-matters

This endpoint uses the same format for requests and responses as the query for groups. For field descriptions and sample JSON, see Retrieve associated groups.

Retrieve associated users

To retrieve information about the users associated with a client, send a POST request to the following URL:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}/query-users

This endpoint uses the same format for requests and responses as the query for groups. For field descriptions and sample JSON, see Retrieve associated groups.

Retrieve available statuses

To retrieve a list of available statuses for a client, send a GET request to the following URL:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/eligible-statuses

The request body is empty.

Endpoints for client domain activation keys

The following endpoints support creating, submitting, and retrying client domain activation keys. For general information, see Client domains on the RelativityOne Documentation site.

Create client domain activation key

To create and return the client domain activation key required to initiate the activation process, send a POST request with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}/client-domain/request-key

The request body is empty.

The response is a string containing the client domain activation key.

Submit a client domain activation key

To submit a client domain activation key and initiate the activation process, send a POST request with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}/client-domain/activation-key

The body of a request contains the following field:

  • activationKey - a string containing the client domain activation key.
{
  "activationKey": "ABCD1234"
}

When the client domain is successfully activated, the response returns the status code of 200.

Retry activating a client domain

To rerun a previously failed activation process, send a POST request with a URL in the following format:

<host>/Relativity.rest/api/relativity-identity/{versionNumber}/workspaces/-1/clients/{clientID}/client-domain/activate

The request body is empty.

When the client domain is successfully activated, the response returns the status code of 200.

Additional Resources

DevHelp Community GitHub Release Notes NuGet

Share knowledge with the Relativity developer community.

Access tools and resources to build an application.

Review the most recent product release notes.

Create .NET Apps faster with NuGet.