API Key Object

Schema for API keys.

Note – You can retrieve and update information about an API key, but you cannot retrieve or update the key itself. The key is visible only when the key's owner first creates it.

            {
                "name": "jane-smith-api-key",
                "description": "Jane's key",
                "id": "070f31c6294fc25e4d113db3",
                "createdAt": 1616439658545,
                "userId": "5f74fc72e6584b325391822b",
                "userEmail": "[email protected]"
            }

name

string

User-defined key name.

description

string

User-defined description.

id

string

Auto-generated ID of the API Key object.

createdAt

UTC timestamp

Timestamp when the key was created.

userId

string

Auto-generated ID of the user who owns this key.

userEmail

string

Email of the user who owns this key.