Less boo. More booked. Halloween offer: 30 days free on any paid plan. Claim 30 days freeEvery new account gets one free mailbox for warmup and replies. No domain to buy. See how it works

Skip to content

List keys

API referenceAPI Keys

From the API Keys API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

text
GET /keys

Returns all of your active (non-revoked) keys, newest first. The raw secret is never returned, only the id, name, prefix, rate limit, and usage metadata.

bash
curl https://app.warmerly.com/api/v1/keys \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
json
{
  "keys": [
    {
      "id": "3b1f6e2a-9c4d-4e2a-8b5f-6a2c1d9e0f7b",
      "name": "CI pipeline",
      "prefix": "wmv_7f3a2c",
      "rateLimitPerMin": 60,
      "lastUsedAt": "2026-07-01T09:12:44.000Z",
      "createdAt": "2026-06-20T14:03:11.000Z"
    },
    {
      "id": "9a2d4c11-5e7b-4f10-b2aa-1c8f0d3e6a4b",
      "name": "Zapier",
      "prefix": "wmv_9d1e0b",
      "rateLimitPerMin": 120,
      "lastUsedAt": null,
      "createdAt": "2026-06-18T08:47:02.000Z"
    }
  ]
}
FieldTypeDescription
idstring (UUID)Key ID, use this to revoke the key.
namestringThe label you gave the key when creating it.
prefixstringThe first few characters of the key (wmv_...), useful for identifying which key is which without exposing the secret.
rateLimitPerMinnumberRequests per minute allowed for this key.
lastUsedAtstring \| nullISO 8601 timestamp of the key's most recent authenticated request, or null if it has never been used.
createdAtstringISO 8601 timestamp of when the key was created.

Revoked keys are excluded from this list entirely.

Was this page helpful?