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
• FED
• DOJ

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 access 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 Create API key dialog.
5. In the Name field, enter a name for the API key.
6. Select the endpoints you want to grant access to for that specific key.
   You can select by category, by individual endpoint, or both.
   
7. Select Continue.
   This takes you to the next step of the dialog, which displays the new key. 
8. Here you can copy or download the key. Select the copy to clipboard button, or select Download key as CSV.
   
9. Store your key in a secure location. You will not be able to access it through Everlaw again.
10. 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 select the toggle to temporarily enable or disable a particular key. You can also choose which endpoints a key has access to. 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. All Organization Admins receive an email notification prior to and upon key expiration.

API endpoint categories

General

Database Operations