Create a new API key

POST

/api-keys

API Keys

Create a new API key for the company.

Authentication: Requires JWT authentication with api_keys scope.

Important: The full API key is only shown once upon creation.
Store it securely - it cannot be retrieved later.

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

API key created successfully

Body

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gvazyknvkqdeuzmrnuwu.supabase.co/functions/v1/api-keys' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Production Integration",
    "description": "Main ERP integration key",
    "scopes": [
        "read",
        "write",
        "transactions",
        "accounts",
        "statements",
        "reports"
    ],
    "expires_in_days": 365
}'

Response Example

201 - Success

{
    "success": true,
    "data": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Production Integration",
        "description": "Main ERP integration key",
        "key_prefix": "elly_abc1234",
        "api_key": "elly_abc1234_defghijklmnopqrstuvwxyzabcdefgh",
        "scopes": [
            "read",
            "write",
            "transactions",
            "accounts",
            "statements",
            "reports"
        ],
        "expires_at": "2026-01-15T10:30:00Z",
        "created_at": "2025-01-15T10:30:00Z"
    }
}

Modified at 2025-12-30 00:32:05

List all API keys

Revoke an API key