Heading API Reference

A property represents a brand or website being monitored for AI search visibility.

List Properties

GET /v1/properties

Returns all properties accessible to the authenticated API key.

Keys with all properties access return every property on the team
Scoped keys return only the properties they are authorized for

Headers

Header	Value	Required
`Authorization`	`Bearer hdg_sk_live_...`	Yes

Example

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

Response — `200 OK`

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Acme Corp",
      "domain": "acme.com",
      "description": "Enterprise SaaS platform",
      "location": "London, UK",
      "locations": ["London, UK", "New York, US"],
      "enabledModels": ["chatgpt", "claude", "gemini"],
      "activePromptCount": 47,
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-20T14:30:00.000Z"
    }
  ],
  "total": 1
}

Response fields

Field	Type	Description
`id`	string	Property UUID
`name`	string	Display name
`domain`	string	Monitored domain
`description`	string or null	Property description
`location`	string or null	Primary location
`locations`	string[]	All monitored locations
`enabledModels`	string[]	AI platforms being tracked
`activePromptCount`	number	Number of active monitoring prompts
`createdAt`	string	ISO 8601 creation timestamp
`updatedAt`	string	ISO 8601 last update timestamp

Error responses

Status	Code	When
`401`	`MISSING_AUTH`	No Authorization header
`401`	`INVALID_KEY`	Invalid or revoked API key
`429`	`rate_limit_exceeded`	Rate limit exceeded (100 req/min)
`500`	`INTERNAL_ERROR`	Server error

Properties

List Properties

Headers

Example

Response — 200 OK

Response fields

Error responses

On this page

Response — `200 OK`