QQuilo Developers
Getting started

Quick start

Create a key, check it with /me, add a client and list clients — in five minutes.

1. Create a key#

  1. Sign in to Quilo and open Settings → API keys.
  2. Enter a name that says where the key will be used, for example Test from my laptop.
  3. Choose Read and write (you will create a client below) and 7 days.
  4. Click Create key and copy the key now. It starts with qk_ and is shown only once.

2. Keep it in your terminal#

Terminal
export QUILO_URL="https://quilo.example.ch"      # your Quilo address
export QUILO_API_KEY="qk_0123456789_…"           # the key you just copied

3. Check who the key is#

Terminal
curl "$QUILO_URL/api/v1/me" \
  -H "Authorization: Bearer $QUILO_API_KEY"

The answer tells you the key's name and access, the person it acts as, the company and the brands you can use:

JSON
{
  "object": "me",
  "key": { "id": "…", "name": "Test from my laptop", "prefix": "qk_0123456789", "scopes": ["read", "write"], "expires_at": "2026-10-24T09:30:00Z" },
  "user": { "id": "…", "email": "amira@dubaijewellery.ch", "name": "Amira Haddad", "role": "owner" },
  "company": { "id": "…", "name": "Dubai Jewellery GmbH", "plan_code": "growth" },
  "brands": [{ "id": "0b7e9a52-1c3d-4f6e-9a8b-7c6d5e4f3a2b", "name": "Dubai Jewellery", "currency": "CHF", "archived": false }]
}

Copy a brand id; every new record needs one.

4. Add a client#

Terminal
curl -X POST "$QUILO_URL/api/v1/clients" \
  -H "Authorization: Bearer $QUILO_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-elena-1" \
  -d '{
    "brand_id": "0b7e9a52-1c3d-4f6e-9a8b-7c6d5e4f3a2b",
    "first_name": "Elena",
    "last_name": "Marti",
    "email": "elena@example.ch",
    "tags": ["website"]
  }'

Quilo answers 201 Created with the new client, including its id. Open Clients in the app: Elena is there, and the activity log shows that you added her.

5. List and search#

Terminal
curl "$QUILO_URL/api/v1/clients?q=marti&limit=10" \
  -H "Authorization: Bearer $QUILO_API_KEY"

6. Clean up#

Delete the test client (owners, admins and managers), then revoke the test key under Settings → API keys.

Terminal
curl -X DELETE "$QUILO_URL/api/v1/clients/CLIENT_ID" -H "Authorization: Bearer $QUILO_API_KEY"

Next steps#