List API keys

GET/v1/api-keys

Returns the account's API keys without their secret values.

Includes keys issued to store installs (source: connector_install) and revoked keys, so you can review access. The key itself is never returned after creation; use prefix and last_used_at to recognise it. Results use cursor pagination. See Authentication.

Permission: integrations.manage
Type: Read-only. Changes nothing.
Auth: API key, MCP token or signed-in session
Capability: list_api_keys
CLI: freeinvoiceautomation key list
Available: At launch, 1 January 2027

list_api_keys

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/api-keys \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f350-5a6b-7c7d-8e9f-0a1b2c3d4e5f",
      "name": "Accounting export script",
      "prefix": "fia_live_7Hq2",
      "scopes": [
        "documents.view",
        "clients.view",
        "payments.view",
        "reports.view"
      ],
      "mode": "draft_only",
      "business_ids": [
        "0193f29e-11aa-7c3b-8d2e-5a6b7c8d9e0f"
      ],
      "rate_limit_per_minute": null,
      "source": "user",
      "last_used_at": "2027-01-20T07:00:12Z",
      "expires_at": null,
      "revoked_at": null,
      "created_by": "0193f29d-2c3d-7e4f-9a0b-1c2d3e4f5a6b",
      "created_at": "2027-01-05T12:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Authorizations

Authorizationstringrequired

Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Query Parameters

revokedbooleandefault:false

Set to true to include revoked keys.

modeenum<string>

Only keys with this mode.

Available options: draft_only, auto_send

limitintegerdefault:50

Page size, 1 to 200.

cursorstring

Cursor from the previous page's next_cursor.

Response

200 - application/json

dataobject[]

The keys on this page.

next_cursorstring | null

Cursor for the next page, or null on the last page.

has_moreboolean

Whether another page exists.

Suggest edits Raise issue

List the audit logPrevious Create an API keyNext

list_api_keys

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/api-keys \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f350-5a6b-7c7d-8e9f-0a1b2c3d4e5f",
      "name": "Accounting export script",
      "prefix": "fia_live_7Hq2",
      "scopes": [
        "documents.view",
        "clients.view",
        "payments.view",
        "reports.view"
      ],
      "mode": "draft_only",
      "business_ids": [
        "0193f29e-11aa-7c3b-8d2e-5a6b7c8d9e0f"
      ],
      "rate_limit_per_minute": null,
      "source": "user",
      "last_used_at": "2027-01-20T07:00:12Z",
      "expires_at": null,
      "revoked_at": null,
      "created_by": "0193f29d-2c3d-7e4f-9a0b-1c2d3e4f5a6b",
      "created_at": "2027-01-05T12:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}