> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goodgrants.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Keys Management

> Generate, edit, and revoke Good Grants API keys.

## 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

<AccordionGroup>
  <Accordion title="Generate API key">
    <Steps>
      <Step title="In Good Grants, go to Settings > Integrations > API Keys" />

      <Step title="Click Generate API Key" />

      <Step title="Enter a key name or purpose" />

      <Step title="Select Scope">
        Select **Read only** for `GET` operations only, or **Read / Write** for full access (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`).
      </Step>

      <Step title="Specify notification email addresses if needed. Separate each address with a comma (,) or semicolon (;)" />

      <Step title="Click Save" />
    </Steps>
  </Accordion>

  <Accordion title="Edit API key">
    <Steps>
      <Step title="In Good Grants, go to Settings > Integrations > API Keys" />

      <Step title="Select the key name or purpose, or open the overflow action menu and click Edit" />

      <Step title="Update the key name or purpose" />

      <Step title="Update Scope">
        Select **Read only** for `GET` operations only, or **Read / Write** for full access (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`).
      </Step>

      <Step title="Update notification email addresses if needed. Separate each address with a comma (,) or semicolon (;)" />

      <Step title="Click Save" />
    </Steps>
  </Accordion>

  <Accordion title="Revoke API key">
    <Steps>
      <Step title="In Good Grants, go to Settings > Integrations > API Keys" />

      <Step title="Open the overflow action menu for the key and click Revoke" />

      <Step title="Click OK in the confirmation dialog" />
    </Steps>
  </Accordion>
</AccordionGroup>