- You must already have access to the Pleo Web App in Staging or Production (you cannot sign in with a personal email account and generate an API key).
- You need Admin or Bookkeeper permissions to see the option to generate API keys.
- If you have the required permissions but do not see the API Keys option under Settings, API Key access is not available. It is determined during onboarding.
- In the Pleo application, go to Settings.
- Click API Keys. The API Keys page appears.
- Click Create API Key.
- Enter the following details:
- Name: An appropriate name for the API key you are generating.
- Expiration: Specify a date until when you want the API key to be active.
- Access Level: Specify whether you want the API key for a specific entity (company) or for multiple entities of a business (organisation).
- Permissions: Select the check boxes next to the scopes you require. Based on your selection, the scopes are enabled in the API key generated at the end of this procedure.
The API key is generated. Copy the API key for future reference.
Note: On the API Keys page, you can view the list of API keys that you have generated. To remove an API key, click the specific row and click Delete.