API keys authenticate requests to the Peach API on behalf of your company. The Admin Portal provides a read-only view of your API keys and their version history, so you can verify which keys are active and track version changes over time.
Availability: All clients Required permissions: company.keys:list (to view)
Note: API keys are read-only in the Admin Portal. To create, update, or delete API keys, use the Peach API.
From the Admin Portal sidebar, select API Keys. The list displays all API keys for your company.
| Column | Description |
|---|---|
| ID | The API key identifier. |
| Description | A description of the key's purpose, if one was provided at creation. |
| Version | The API version this key uses (format: YYYY-MM-DD). Select to open version history. |
| User | The user account associated with this key. |
| Key | The API key value. |
| Last updated | The date and time the key was last modified. |
| Status | Whether the key is Active or Inactive. |
Use the Status filter to show only Active or Inactive keys. Select the column management icon to show, hide, or reorder columns. The list displays 50 keys per page.
Each API key tracks its version changes over time. To view the history:
- From the API Keys list, select the Version link for a key.
- The version history dialog opens, showing a table of all version changes.
| Column | Description |
|---|---|
| Updated at | The date and time of the version change. |
| Old version | The previous API version (YYYY-MM-DD). |
| New version | The updated API version (YYYY-MM-DD). |
By default, the dialog shows the four most recent changes. Select Show all version history to see the full list.
API versions are date-based (YYYY-MM-DD) and determine which version of the Peach API a key interacts with. When Peach releases API changes, keys continue using their assigned version until explicitly upgraded.