GET/keys

List API Keys

List all API keys for your tenant. Key values are never returned — only prefixes and metadata.

🔒Scope required:admin

Request Example

curl https://api.scootsign.com/api/v1/keys \
  -H "X-API-Key: aram_ent_ADMIN_KEY..."

Response

{
  "success": true,
  "data": [
    {
      "id": "key_abc123",
      "name": "CI/CD Pipeline",
      "keyPrefix": "aram_ent_a1b2",
      "scopes": ["read", "write"],
      "isActive": true,
      "expiresAt": "2026-06-01T00:00:00.000Z",
      "lastUsedAt": "2026-03-01T10:30:00.000Z",
      "usageCount": 1423,
      "createdAt": "2026-03-01T09:00:00.000Z"
    }
  ]
}

Response Fields

FieldTypeDescription
idstringUnique key identifier
namestringFriendly name
keyPrefixstringFirst 12 characters of the key (for identification)
scopesstring[]Allowed scopes
isActivebooleanWhether the key is active (false if revoked)
expiresAtstring | nullISO 8601 expiration date, or null if permanent
lastUsedAtstring | nullLast time the key was used
usageCountintegerTotal number of requests made with this key
createdAtstringWhen the key was created
Aram by ScootSign docs.scootsign.com