401 Unauthorized

Problem type https://www.getproperly.com/developers/errors/unauthorized

HTTP status	`401`
type	`https://www.getproperly.com/developers/errors/unauthorized`
title	`Unauthorized`
Content-Type	`application/problem+json`

When it occurs

The x-api-key header is missing or does not match an active key.

Example

401 Unauthorized

{
  "type": "https://www.getproperly.com/developers/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Missing or invalid x-api-key",
  "instance": "/v1/properties",
  "code": "unauthorized",
  "requestId": "aQ3fT8xW1m"
}

Handling

Send the key in the x-api-key request header on every route except GET /v1/health. Keys are never accepted in the URL.
A revoked key stops working on the next request, and a newly issued key works immediately.
Issue or revoke keys in the Properly web app under Settings → API & AI assistants.

All problem types are listed on the Errors page.