Eligibility API

Overview

Retrieve the complete list of property IDs that are available for your account. Use this as the first step to find which properties you need to download.

Method: GET
Endpoint: https://example-server.com/api/v2/properties/eligibility
Authentication: Required (Use OAuth 2.0)
Rate Limited: Yes

Request example

curl -X GET \
  'https://example-server.com/api/v2/properties/eligibility' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response example

{
  "meta": {
    "status": "SUCCESS"
  },
  "data": {
    "properties": [
        461790,
        123456,
        789012
    ]
  },
  "errors": []
}

Next steps

Call the Properties API for the eligible properties in batches to fetch full content.

📘
Property eligibility can change over time (new properties added, some removed from your scope). Use the CDS API for ongoing eligibility changes, or periodically re-call the Eligibility API to refresh your catalog list.