To access the Gridly API, you need API keys. Gridly supports two types of API keys: shared API keys for company-wide use and personal API keys for individual members. This article will show you how to create and manage both types of API keys.

Shared API keys

Creating shared API keys

1. In your Gridly Homepage, click Company settings. 
2. Select the Gridly API keys tab.

3. Click Create API key.
4. You will be redirected to Create API Key page. Enter a name in API key name field.
5. Select an option for API Key permission.
   3. Full Access: Users with this API key have full access and permissions to the Company data
   4. Restricted Access: Users with this API key have limited access and permissions. If this is selected, Privileges settings will appear, allowing further access customization for this API key.
6. Click Save.

Managing shared API keys

To edit, duplicate, regenerate, revoke, or delete an API key, click on the corresponding key and select an option. 

To temporarily disable an API key for security reasons (e.g. preventing public access to your data when merging branches), clicknext to the key status and select Disabled. No requests can be made using this API key until you change its status back to Active.

Personal API keys

Personal API keys are individual API keys assigned to each company member for their personal use with the Gridly API.

For Admins: Activate/Deactivate personal API keys

1. From Gridly Homepage, click Members on the left-hand side toolbar.
2. Find the member you want to activate/deactivate personal API key and click the icon in their row.
3. Select Activate personal API key or Deactivate personal API key.

When a personal API key is deactivated, the member cannot use their personal API key for Gridly public API calls.

For Admins: Find personal API key owner

1. In your Gridly Homepage, click Company settings. 
2. Select the Gridly API keys tab.
3. Click the Find personal API key button.

4. In the search dialog, enter the personal API key you want to look up.

5. Click Search to view the key owner details including: Member name, Email address, Company role, Last used date.

For Users: Finding your own Personal API key

1. Open a Grid in the CMS module.
2. Click on the icon on the right-hand side toolbar. Here you can find your personal API key, which is censored for security reasons.
3. Click the icon to copy it or Regenerate Key to get a new key.

If your personal API key is deactivated, you will see the following message instead.