docs/api reference/Get API Key
Home ↗
POST/api/auth/generate

Get API Key

Generate a new API key tied to a caller identity. The key is returned once — save it immediately. All protected endpoints require it in the x-api-key header.

Parameters

ownerstringrequired

Credential owner name.

emailstringrequired

Owner email address.

How to use

curl -X POST https://api.parcelkit.us/api/auth/generate \
  -H "Content-Type: application/json" \
  -d '{"owner":"Acme Corp","email":"dev@acme.com"}'
response.json
{
  "message": "API Key successfully generated",
  "apiKey": "sk_live_060483d61a25aef2ad1ab5b9fc0d2e8b",
  "owner": "Acme Corp",
  "email": "dev@acme.com",
  "credentialName": "lonestarCAD_apikey_Acme_Corp",
  "status": "active",
  "createdAt": "2026-06-12"
}
curl -G https://api.parcelkit.us/api/property/search \
  -H "x-api-key: sk_live_your_key" \
  --data-urlencode "q=10 Woodborough Way, Spring TX 77389"

Your key is shown only once at generation time. If you lose it, POST again with the same owner and email to issue a replacement.