Users who are given the permission of API Access will be able to create unique secret keys. These “keys” will provide the user access to both Paradox public APIs and custom inbound APIs for their Paradox account.

Enable API access

Please contact your CS Representative in order for them to provide the preferred user API access.

Navigation

If you are assigned to a user role that has API access, Account IDs and API Keys can be accessed from your My Profile.

1. Select your avatar and then My Profile in the drop-down menu that opens.
   
   
    
2. On the page that opens, select the Settings button in the top right corner above your My Profile details.
3. In the slide-out drawer that opens, scroll down to the Account ID and API Secret section.
   
   

Available actions

An Account ID and API Secret section will be added to the bottom of your My Profile Settings drawer. Two actions will be available in this section:

1. Generate API Secret – This will create a secret API key that can be used for all integrations (employees, locations, and candidate as the source). When an API is generated, it can be viewed below this button.
2. Copy Account ID – This is a read-only field that can be copied and used for any API-based integration.

Generate an API Key

To generate an API key, navigate to your My Profile and scroll to the Account ID and API Secret section. Within this section, select the Generate API Secret button to create a new API Key.

• Note: You do not need to create a new key each time you have an integration. Rather, click the Copy button at the end of the generated API Secret Key and use this for your integration.

The API Key will then be listed underneath the Generate New API Secret button in a new field called API Secret. By default, it will display a masked value, but when clicking the crossed-out eye icon, you can view the unmasked value. Ensure to save the API key and then select Copy to copy it for the desired integration. 

Delete an API key

If you want to delete an API Key, click the trash can icon next to the generated API Key and then confirm the deletion in the modal that appears. This will impact any current integrations that use this API Key.