API Documentation - Communities

Table of Contents

Single Community End-point

Returns data about a single community stored in Funnel.

GET /api/v2/communities/<community_id>/

Example response body:

{
  "id": 123,
  "team_id": 121,
  "name": "The Chelsea Muse",
  "street_address": "150 West 22nd Street"
  "city": "New York",
  "postal_code": "10011",
  "logo": null,
  "apartment_features": [
    "Kitchen island",
    "Hardwood Fllors",
    "Patio/balcony",
    "Granite countertops",
    "Stainless steel appliances",
    "USB charging ports",
    "Walk-in closet",
    "Washer and dryer"
  ],
  "parking_options": [],
  "state": "WA",
  "amenities": [
    "24/7 maintenance",
    "BBQ area",
    "Bike storage",
    "Elevator",
    "Storage space available",
    "Management on-site",
    "Pet friendly",
    "Resident lounge",
    "Rooftop terrace",
    "Smoke-free community"
  ],
  "pets": {
    "restrictions": "The following breeds are not allowed: Rottweilers, Doberman Pinschers, Pit Bulls, German Shepherds, Chow Chow, and wolf hybrids.",
    "fee": null,
    "notes": "Pets must be spayed/neutered.",
    "deposit": 300.0,
    "deposit_dogs": null,
    "extra_rent": 25.0,
    "breed_restriction": 1,
    "deposit_refundable": null,
    "deposit_cats": null,
    "fee_cats": null,
    "extra_rent_dogs": 25.0,
    "policy": "Pets Allowed",
    "fee_dogs": null,
    "extra_rent_cats": 25.0,
    "max_allowed": 2,
    "interview_required": null,
    "max_weight": null
  },
  "special_offers": "1 month free on 12 month leases",
  "contact_phone": "(212) 555-9188",
  "website_url": "http://bestcommunity.apartments",
  "description": "The Chelsea Muse apartments in the heart of Manhattan offer luxury living with easy access to the city.",
  "utilities": {
    "water": {
      "company": "City of New York",
      "paid_by_property": null,
      "fees": "Pay to community"
    },
    "sewer": {
      "company": null,
      "paid_by_property": false,
      "fees": null
    },
    "electric": {
      "company": "Con Edison",
      "paid_by_property": false,
      "fees": ""
    },
    "cable": {
      "company": "Comcast",
      "paid_by_property": false,
      "fees": ""
    },
    "internet": {
      "company": "Comcast",
      "paid_by_property": false,
      "fees": null
    },
    "trash": {
      "company": null,
      "paid_by_property": false,
      "fees": "Pay to community"
    },
    "gas": {
      "company": "National Grid",
      "paid_by_property": false,
      "fees": ""
    },
    "telephone": {
      "company": "Comcast",
      "paid_by_property": false,
      "fees": ""
    },
    "pest_control": {
      "company": null,
      "paid_by_property": false,
      "fees": null
    }
  },
  "photos": [
    {
      "description": "a dining room table in front of a window",
      "id": 773761,
      "sort_order": 0,
      "media_type": "Photo",
      "original": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?s=a51703d90404d302f030b5b79c1b324a",
      "large": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
      "thumbnail": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
      "small": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
      "xlarge": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a"
    },
    {
      "description": "a store front at day",
      "id": 773762,
      "sort_order": 1,
      "media_type": "Photo",
      "original": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?s=a51703d90404d302f030b5b79c1b324a",
      "large": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
      "thumbnail": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
      "small": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
      "xlarge": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a"
    },
    {
      "description": "a table that has a sign on the side of a building",
      "id": 773763,
      "sort_order": 2,
      "media_type": "Photo",
      "original": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?s=a51703d90404d302f030b5b79c1b324a",
      "large": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=540&w=720&s=2334719c403d5c8f2a07e81369e4cca9",
      "thumbnail": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=70&w=100&s=a3d5d4b3fe655f23f04e8ce9e493e1c9",
      "small": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=crop&h=180&w=240&s=8ca556ba82008a5c3cbcb53e1ab00ffb",
      "xlarge": "https://assets-img.nestiostatic.com/unit_photos/originals/1e33cf2e65d517301adce1fda8f30e76.jpg?fit=max&h=1000&w=1000&s=20297f84cb26b5208a6ab5f043688a1a"
    }
  ],
  "affordable_housing_notes": "Section 8 accepted, please contact community for more information",
  "affordable_housing_offered": true,
  "year_built": "2013",
  "sister_communities": [
    {
      "city": "New York",
      "name": "The Flatiron Muse",
      "state": "NY",
      "team_id": 456,
      "postal_code": "10010",
      "street_address": "20 West 22nd Street",
      "id": 908,
      "website_url": "http://anothergood.apartments",
      "description": "The Flatiron muse apartments in New York, NY offer true lifestyle living."
    }
  ],
  "unit_types": [
    {
      "description": "",
      "id": 124,
      "name": "1 Bed 1 Bath Terrace"
    },
    {
      "description": "",
      "id": 125,
      "name": "2 Bed 2 Bath"
    },
    {
      "description": "",
      "id": 131,
      "name": "1 Bed 1 Bath"
    }
  ],
  "hours_of_operation": {
    "monday": {
      "close_at": null,
      "is_closed": true,
      "open_at": null
    },
    "tuesday": {
      "close_at": "18:00:00",
      "is_closed": false,
      "open_at": "09:00:00"
    },
    "friday": {
      "close_at": null,
      "is_closed": true,
      "open_at": null
    },
    "wednesday": {
      "close_at": null,
      "is_closed": true,
      "open_at": null
    },
    "thursday": {
      "close_at": "18:00:00",
      "is_closed": false,
      "open_at": "09:00:00"
    },
    "sunday": {
      "close_at": null,
      "is_closed": true,
      "open_at": null
    },
    "saturday": {
      "close_at": "18:00:00",
      "is_closed": false,
      "open_at": "14:00:00"
    }
  }
}