API reference

Quick start

1. Create a key on your Account page (API keys). It starts with pk_live_ and is shown once.

2. Send it as a Bearer token. Read-only endpoints are GET with arguments in the query string; everything else is POST with a JSON body (POST also works for read endpoints).

curl "https://powerkitpro.com/api/v1/qr/list?limit=5" -H "Authorization: Bearer pk_live_..."

curl -X POST https://powerkitpro.com/api/v1/qr/create \
  -H "Authorization: Bearer pk_live_..." -H "Content-Type: application/json" \
  -d '{"name":"Front window","target_url":"https://example.com/menu"}'

3. Read the answer. Success is 200 {"ok":true,"text":"...","data":{...}}: text is a readable summary (Markdown), data the same thing as JSON. Lists carry total, count, offset, has_more and items.

401 {"ok":false,"error":"unauthorized","message":"Invalid API key. Create one on your Account page."}
400 {"ok":false,"error":"invalid_input","message":"...","issues":[{"path":"target_url","message":"Required"}]}
400 {"ok":false,"error":"tool_error","message":"This plan allows 3 codes and all are used. ..."}
404 {"ok":false,"error":"not_found","message":"..."}
429 {"ok":false,"error":"rate_limited","message":"...","retryAfter":3600}   (also a Retry-After header, seconds)

Limits. 100 calls a day per key on free plans, 5,000 a day on any paid PowerKit Pro plan. Every call runs as you and keeps to your plan's limits, so a tool can answer with tool_error when a plan is full. Responses are never cached and the API sends no CORS headers: call it from a server, a script or the CLI, not from a browser page.

Any tool by name. POST /api/v1/call with {"name":"powerkit_qr_create","arguments":{...}} runs any endpoint below by its tool name. GET /api/v1/tools returns this whole reference as JSON (name, method, path, JSON Schema input, hints), which is what the CLI reads.

Command line

npm i -g powerkit-pro
powerkit login                      # paste your key once; it is kept in the system keychain
powerkit tools                      # every command, grouped by product
powerkit qr create --name "Flyer" --target-url https://example.com
powerkit booking list --limit 20 --json
powerkit import certs issue --csv people.csv    # one call per row, headers map to flags
powerkit call powerkit_qr_stats --json '{"id":"..."}'

Endpoint names map to commands: powerkit_qr_create is powerkit qr create, and each argument is a flag (target_url is --target-url). --help on any command lists its flags with the descriptions below. Exit codes: 0 ok, 1 tool error, 2 usage, 3 not authorized, 4 rate limited. POWERKIT_API_KEY and POWERKIT_BASE_URL work in CI.

Zapier and Make

Use a Webhooks by Zapier (or Make HTTP) step: method POST, URL from the table below, header Authorization: Bearer pk_live_..., JSON body with the arguments. For lists, use GET with the arguments as query string parameters. Forms and waivers can also push each response to your own webhook URL from their settings on Pro and up, with no key needed.

Endpoints

• Account
• QR codes
• Business cards
• Proposals
• Booking pages
• QR menus
• Reviews
• Link pages
• Certificates
• Event programs
• Seating charts
• Forms
• Waivers
• Support and invites

Account

QR codes

Business cards

Proposals

Booking pages

QR menus

Reviews

Link pages

Certificates

Event programs

Seating charts

Forms

Waivers

Support and invites

Questions or a tool you need that is not here: support@powerkitpro.com.