Uploading an image to an API key

Available for Roles Super Admin
Permissions • Manage API credentials and manage integrations
Packages LeverTRM, LeverTRM for Enterprise

If you would like to surface images alongside objects created via Lever's API, you can add an image to an API key any time a new key is created. To learn how to create a new key, refer to our help article on generating API keys.

During the key generation process, you will have the option to drag and drop your image, or upload an image from your computer to be used by the API key.

API key generation configuration; image upload field is highlighted

The image you select must be in .png format, and smaller than 500 KB. For the best results, use a square image no larger than 400x400 pixels and is on a white, or solid color background.

image with solid color background.

After uploading an image to an API key, this image will be displayed in Lever on objects (e.g. forms, notes) created using this key. The endpoints that will display this image when a key is used are denoted by an asterisk when selecting the permissions for your API key. Currently, images can be used with the create note and create profile forms endpoints.

Note on a candidate's profile; API image appears next to note

Was this article helpful?
0 out of 0 found this helpful