Account

Retrieve an API key

Retrieve a single API key of your account by its id (UUID v7). The plaintext secret is never included. A key that does not belong to that account returns 404 api_key_not_found (anti-enumeration), and so does an account identifier that is not yours.

get/accounts/{account}/api-keys/{api_key}

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/accounts/{account}/api-keys/{api_key}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

accountstring uuid required

Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).

api_keystring uuid required

Public identifier (UUID v7) of the API key.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-4d6e7f8a9b0c",
    "object": "api_key",
    "name": "Producción",
    "prefix": "fact_live_1OSf9KdP",
    "scopes": [
      "account:read",
      "invoices:read",
      "invoices:write"
    ],
    "tier": "scale",
    "environment": "live",
    "created_at": "2026-01-15T09:30:00Z",
    "last_used_at": "2026-05-25T18:00:00Z",
    "is_active": true,
    "ip_allowlist": [
      "203.0.113.10",
      "198.51.100.0/24"
    ],
    "last_used_ip": "203.0.113.10",
    "nif_scope": [
      {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
        "tax_id": "B12345674",
        "name": "Acme Soluciones SL",
        "access_level": "operate"
      }
    ],
    "created_by": {
      "id": "01931b3e-7c4a-7f2e-9a8b-4d6e7f8a9b11",
      "name": "Marta Ibáñez"
    },
    "revoked_by": {
      "id": "01931b3e-7c4a-7f2e-9a8b-4d6e7f8a9b11",
      "name": "Marta Ibáñez"
    },
    "secret_rotated_by": {
      "id": "01931b3e-7c4a-7f2e-9a8b-4d6e7f8a9b11",
      "name": "Marta Ibáñez"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.