Organization Admin: Everlaw API

Everlaw's API (application programming interface) lets your custom programs interface directly with Everlaw to automate processes like custom reporting to provide detailed analytics, billing tracking, and uploading native data. Everlaw's API allows the flexibility to support your automation of complex and unique workflows at scale. 

Everlaw’s API empowers engineers or technical experts to build programs or scripts that interface with Everlaw.

Requirements

• You must be an Organization Admin to generate an API key for that organization.
• A valid organization API key is valid for all API endpoints. To learn more about authentication to Everlaw’s API, visit your region’s documentation

API documentation by region

Copies of the technical documentation describing specifics are hosted directly on each deployment of Everlaw:

• United States
• United Kingdom
• Canada
• European Union
• Australia

API Keys / Security

The API keys tab of the Organization Admin pagelets you generate secure keys for your organization to connect your programs with Everlaw. An API key is a long string of letters and numbers equivalent to a password. It allows programs equivalent access to an Organization Admin, but is not tied to the creator's user account.

Parent organization vs sub-organization API key permissions

API keys can be generated for a parent organization and sub-organizations, and are managed in an identical manner. The only difference is that parent organization API keys can access sub-organization information via select endpoints:

• GetOrganizationEvents
• GetOrganizationEventsAfter
• GetRecentOrganizationEvents
• GetProjectEvents
• GetProjectEventsAfter
• GetRecentProjectEvents
• GetOrganizationBilling
• GetDatabaseBilling
• GetProjectBilling
• GetProjectSize
• GetOrganizations
• GetDatabases
• GetProjects

All other endpoints only return parent organization information when accessed with a parent organization API key.

For information on individual endpoint permission requirements, visit our API documentation for your Everlaw region and see the Required permissions section under the given endpoint.

Access your organization's API Keys

Required permission: Organization Admin

To manage your organization's keys:

1. Go to your Organization home page.
2. [If you have multiple organizations or sub-organizations] Select the organization you would like to access from the organization list in the Everlaw page header. 
3. From the side navigation panel, select API Keys.
   This opens the API Keys page.
   

Create an API key

Required permission: Organization Admin

To create an API key:

1. Go to your Organization home page.
2. [If you have multiple organizations or sub-organizations] Select the organization you would like to access from the organization list in the Everlaw page header. 
3. From the side navigation panel, select API Keys to open the API Keys page.
4. Select + Create API Key.
   
   This opens the New API key dialog.
5. In the Name field, enter a name for the API key.
6. Select Continue.
   This takes you to the next step of the dialog, which displays the new key. 
7. Here you can copy or download the key. Select the copy to clipboard button, or select Download key as CSV.
   
8. Store your key in a secure location. You will not be able to access it through Everlaw again.
9. Once you have your API key secured, select Done to close the dialog

Manage existing API keys

To manage your organization's keys, go to your organization's API Keys page, and click the toggle to temporarily enable or disable a particular key. You can also choose whether a key only has read-only privileges, or read/write privileges that can leverage Everlaw’s upload API. Click the X to permanently revoke a key. You’ll see the dates each key was created or last used by an application or script. The prefix for each key is the first several digits of the API key, and can be used to help identify your keys offline.

For security reasons, Everlaw automatically disables API keys after 90 days of inactivity, and all Organization Admins receive an email notification prior to and upon key expiration.

API endpoint categories

Search API / custom analytics reporting

Everlaw’s Search API allows you to build out custom analytics reporting with the same flexibility as Everlaw’s visual instant search. Automated searches return the number of documents which hit on that search, the number of groups for grouped searches, and, optionally, the billable size or number of pages for documents that hit on that search.

Most search terms available in Everlaw’s visual instant search, including contents, metadata, codes, binders, assignments, redactions, uploads, productions, are available as API queries. This allows your team to build automated, custom reports outside of Everlaw using this information.

For example, a program might pull stats for Everlaw uploads across your organization recording the information in an external database or spreadsheet by upload.  When certain processing error levels diverge from the norm, it could serve as a trigger for closer investigation. Or, you might wish to visualize assignment progress across a case or organization in your own data visualization program outside of Everlaw. Automated reports leveraging the codes and assigned terms could periodically update your custom view of this data. 

When you use the Search API, you can access document-level information for the results, which makes them more actionable. The document-level information available for each document returned by the search is:

• Bates/Control # 
• Document ID
• Metadata
• URL to open that document in the review window

Upload API

Everlaw’s Upload API lets you build programs to automatically upload native data to Everlaw, letting you automate your data pipeline and integrate your upload process with Everlaw. You can configure uploads with all the processing settings available in the upload wizard, with the additional flexibility to turn off de-Nisting if needed. You can provide direct links or local files for upload. 

This allows you to automate data ingestion into Everlaw. For example, if aspects of your process include manual repeated steps to ingest data, a program could use Everlaw’s API to instead upload data when certain triggers occur. 

Billing API

You can use Everlaw’s API to automatically pull billable size information for projects and databases, including ECA projects. This includes both final and peak sizes. 

This allows you to integrate Everlaw’s billing information into your own billing system to get real-time insight into your spend without needing to wait for invoices or manually cross-reference.

Project administration and user analytics

Everlaw’s API lets you pull project administration information for your organization like users, latest user activity, user identifiers, permission groups, and some project settings. It also lets you track the most recent activity date for a project or database. 

This can be especially helpful when you need to track project names or other information in a separate system from Everlaw. Instead of manual cross-referencing, a program leveraging Everlaw’s API could automatically provide this information in your source of record.

Administer users

Required Permissions: The API key must have read/write permission for any action that changes anything about a user or their permissions.

You can use the API at each level for the following:

• Project level
  • Invite new users to projects
  • Add and remove users from project permission groups
  • Remove users from a project (sharing work product with project admins)
  • Resend pending user invitations
  • Deactivate pending user invitations
• Database level
  • Add or remove database permissions for users
• Organization level
  • Add and remove user identifiers
  • Add and remove users from the organization (sharing work product with project admins)
  • Add and remove Org Admin permissions
  • Track existing Org Admin permissions (requires only Read permissions for the API key)

 

Track user activity

This API allows your organization to monitor Everlaw user activity and integrate that information into additional tools, like those used for cybersecurity monitoring. 

Information on user activity available through the API mirrors what is available in Everlaw, including user names, project names, and case-specific information like the names of codes. Specifically, you can use the API to gather information on user activity from each of the following levels:

• Organization User Access History on the Organization home > User Access History tab
• Database events on the Database Settings > Admin activity tab
• Project Admin activity on the User Activity > Admin tab
• Historic User Activity from the User Activity >  Historic tab.

Here is some additional information about using this API:

• The information accessible at each of the levels described above is accessed through either an Organization or Project endpoint. Database events are captured either by the Organization or Project endpoints, depending on the event
• User activity events are available in batches, based on a query for:
  • A given date range
  • Events that follow a selected event
  • A given number of recent events 
• Events become available in close to real-time, so a batch queried for the current date will pull in all user activity up to five minutes before the current moment.
• For security purposes, the responses will have 'data' and 'description' fields with null values when calling user activity endpoints using a parent organization API key. Full responses are available to sub-organization API keys.