Skip to main content
GET
/
accounts
/
{account_id}
/
comp_sets
List Competitive Sets
curl --request GET \
  --url https://data.apartmentiq.io/apartmentiq/api/v1/accounts/{account_id}/comp_sets \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "11848667",
      "type": "comp_set",
      "attributes": {
        "name": "Bowery Bayside Market",
        "min_floorplan": 0,
        "max_floorplan": 2,
        "image": "https://apartmentiq-assets.rentable.co/images/accounts/1111/comp-sets/11848667.jpg",
        "market_survey": true,
        "category": "market_survey",
        "custom_property": false,
        "value_add": false,
        "addresses": [
          "6301 S Westshore Blvd Tampa FL 33616"
        ],
        "owned_property_addresses": [
          {
            "id": 99000673,
            "address": "6301 S Westshore Blvd",
            "city": "Tampa",
            "state": "FL",
            "zip_code": "33616"
          }
        ],
        "subject_property_ids": [
          "99000673"
        ],
        "created_at": "2024-02-13T12:00:00Z",
        "show_recommendations_link": true
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter a Bearer token obtained via the OAuth client credentials flow or from the Access Tokens tab in your account settings.

Path Parameters

​
account_id
integer
required

ID of the ApartmentIQ account to get the list of comp sets for.

Response

A Map with a data attribute that contains an array of all comp sets the user has access to in the given account.

​
data
object[]