KeyWe API

Authentication

Every request must carry your API key in theAuthorization header. Keys start withkw_live_ and are shown only once: keep them like a password.

At creation, you choose the key's rights — Read (view your keyrings) and/or Create codes. Grant the minimum needed: a key lacking the required right gets a403. The API is also limited to 120 requests per minute per key (429 response, Retry-After header).

curl https://keywe.io/api/v1/cles \
  -H "Authorization: Bearer kw_live_your_key"

Endpoints

• GET/api/v1/clesLists your keyrings: status, location, slot, return deadline.
• POST/api/v1/codesCreates a pickup code for a key and emails it to the recipient.

Create a pickup code

The typical call at booking time: the guest gets their code by email, valid for 7 days.

curl -X POST https://keywe.io/api/v1/codes \
  -H "Authorization: Bearer kw_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "key_id": "b0000000-0000-4000-a000-000000000001",
    "beneficiaire_nom": "Léa Martin",
    "beneficiaire_email": "lea@exemple.fr",
    "validite_jours": 7
  }'

Response

{
  "id": "c0000000-0000-4000-a000-000000000009",
  "code": "H7KM2P",
  "qr_payload": "KEYWE:H7KM2P",
  "expire_le": "2026-07-30T10:00:00.000Z",
  "cle_en_depot": true
}

Response codes