Skip to main content

​
API key scopes

API scopes allow you to restrict access for third parties using an API key. Adding a scope helps protect your and your applicants’ data by limiting what third parties can access. You can apply one of the following scopes to any API key:
  • Read only — Use for GET operations. Only allows third parties to view data associated with the endpoint.
  • Read / Write — Use for GET, POST, PUT, PATCH, and DELETE operations. Allows third parties to create, update, and delete data associated with the endpoint (set by default).

​
Manage API keys

1

In Good Grants, go to Settings > Integrations > API Keys

2

Click Generate API Key

3

Enter a key name or purpose

4

Select Scope

Select Read only for GET operations only, or Read / Write for full access (GET, POST, PUT, PATCH, DELETE).
5

Specify notification email addresses if needed. Separate each address with a comma (,) or semicolon (;)

6

Click Save

1

In Good Grants, go to Settings > Integrations > API Keys

2

Select the key name or purpose, or open the overflow action menu and click Edit

3

Update the key name or purpose

4

Update Scope

Select Read only for GET operations only, or Read / Write for full access (GET, POST, PUT, PATCH, DELETE).
5

Update notification email addresses if needed. Separate each address with a comma (,) or semicolon (;)

6

Click Save

1

In Good Grants, go to Settings > Integrations > API Keys

2

Open the overflow action menu for the key and click Revoke

3

Click OK in the confirmation dialog