Get API Keys

GET /api/keys

This endpoint retrieves a list of API keys and their metadata.

Note

There is currently no way to create or delete API keys through the API.
This must be done through the dashboard.

Security

This endpoint requires authentication. You must include a valid API key in the request header. Permission(s) Required: EDIT_API_KEYS

Response Body

[
    {
        "id": string,
        "prettyName": string,
        "perms": string[],
        "creatorFirstName": string,
        "creatorLastName": string,
        "creatorEmail": string,
        "created": timestamp,
        "lastUsed": timestamp
    },
    {...}
]

id

Unique identifier for the API key.

prettyName

The name of the API key. This is for your reference only and does not affect the functionality of the key.

perms

The permissions granted to the API key.

creatorFirstName

The first name of the user who created the API key.

creatorLastName

The last name of the user who created the API key.

creatorEmail

The email of the user who created the API key.

created

Unix Epoch format (millis). The timestamp of when the API key was created.

lastUsed

Unix Epoch format (millis). The timestamp of when the API key was last used.