API

Properties

List monitored properties and their configuration

A property represents a brand or website being monitored for AI search visibility. The API returns properties on a paid plan only. Free properties do not appear.

List properties

GET /v1/properties

Returns paid properties in the API key's scope. Ordered by creation date, newest first.

  • Keys with all properties access return every paid property on the team
  • Scoped keys return only their authorised paid properties

Headers

HeaderValueRequired
AuthorizationBearer hdg_sk_live_...Yes

Query parameters

ParameterTypeDescription
limitintegerMaximum results per page. Default: 100, max: 1000.
offsetintegerRows to skip. Default: 0.

Example

curl https://api.useheading.com/v1/properties \
  -H "Authorization: Bearer hdg_sk_live_abc123..."

Response: 200 OK

{
  "data": [
    {
      "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
      "name": "Acme Corp",
      "domain": "acme.com",
      "description": "Enterprise workflow automation platform",
      "location": "United States",
      "locations": ["United States", "United Kingdom"],
      "enabledModels": ["chatgpt", "google_ai_overview", "perplexity"],
      "activePromptCount": 30,
      "createdAt": "2026-03-15T00:00:00.000Z",
      "updatedAt": "2026-07-01T00:00:00.000Z"
    }
  ],
  "total": 1
}

Response fields

FieldTypeDescription
idstringProperty UUID
namestringDisplay name
domainstringPrimary domain
descriptionstring or nullProperty description
locationstring or nullPrimary monitoring location
locationsstring[]All monitoring locations
enabledModelsstring[]AI platforms tracked for this property
activePromptCountnumberCount of active monitoring prompts
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last-update timestamp

Error responses

StatusCodeWhen
400INVALID_PARAMInvalid query parameter
401MISSING_AUTHNo Authorization header
401INVALID_AUTHHeader is not Bearer {key}
401INVALID_KEYInvalid or revoked API key
429RATE_LIMIT_EXCEEDEDRate limit exceeded (100 req/min)
500INTERNAL_ERRORServer error