The Diligent Workflow API facilitates the integration of our Diligent platform with your organization’s systems. We provide endpoints so that you can construct the request you want to send to the Diligent platform.

The API is used to undertake the following actions:

• Create Jobs

• Update Jobs

• Extract reports on users, jobs, custom fields, and job expiries.

The Diligent Workflow API is built around REST principles. It uses standard HTTPS requests to access data and returns responses in JSON format.

To start interacting with the Diligent Workflow API you will need the following:

• Diligent Workflow API must be configured for your site or organization. This is undertaken by our support teams.

• You need to be added as an External API user. This must be completed by your organization’s administrator.

• A personal API token must be generated to access the API. This must be completed by your organization’s administrator.

The Diligent Workflow API is available on request. To enquire about your current package and discuss upgrade options, contact your Customer Success Manager (CSM).

Each Diligent Workflow site you want to configure for API requests, requires internal network configuration.

To request that your sites are configured, contact your Customer Success Manager, and provide the web address for each site, including test sites.

We recommend you create a user in Diligent Workflow that is used solely for making API requests and create a new user role for this user with only the required user role rights or permissions. This must be completed by an administrator for your organization.

To learn how to create an API user go to Add an API user

All requests require authentication. To authenticate, use Diligent Workflow to create a token (API key) for your account. The token (API key) is a string that authenticates you and allows you to securely access the Diligent Workflow API.

To learn how to create a token go to Generating a personal API token

After you have created your token, you can enter it in the header of your request:

Authorization: Bearer <TOKEN>

Important: If you do not authenticate yourself, the API fails. The API responds to authentication failures with a 401 "Bad credentials" status.

Once you have completed the authentication process, you can start sending requests.

• GET — used for retrieving resources

• POST — used for creating resources

• PUT — used for updating resources

All API endpoints use a version number in the path. As can be seen in the examples, /v1/ specifies version 1 of the API.

Current Version - 1