Warning: Only resources, actions, and attributes documented here should be considered public. Any undocumented resources, actions, or attributes should be considred private and may change at any time without notice. Be extra cautious of undocumented attributes since those are the most likely to change.

If you with to use a undocumented portion of the API, please contact us first so we can either a) document it and make it public or b) explain what planned changes are in store for that part of the API.

Properties API

Whenever an applicant applies, they are applying to a property.

There are 3 types of Properties: Multi Family, Single Family, and Generic. Multi-Family can have multiple floor plans and the application form will prompt the applicant to choose a floor plan and to describe their desired unit. A Single Family property only has 1 floor plan and the application form will not ask the applicant to choose a floor plan nor describe the desired unit. A Generic property doesn’t prompt the applicant for a floor plan and asks the applicant to describe their desired property. A generic property is sometimes used to represent a portfolio of single family homes.

POST

/api/v2/properties

Creates a property and a default floor plan. Use the Floor Plans API after creating a property to modify the floor plans.

available, optional boolean	Defaults to `true`
kind string, optional	Possible values are `multi_family`, `single_family`, and `generic`. Defaults to `multi_family`.
name string, required	Example: Queens Island Apartments
street string, optional	Example: 1914 East 9400 South
city string, optional	Example: Sandy
state string, optional	Example: UT
zip string, optional	Example: 84093
invitation_only boolean, optional	Defaults to `false`.
invitation_only_message string, optional	If an applicant arrives at an invitation only property without an invitation, this message will be presented to the applicant.

Example Request

{
  "property": {
    "name": "Queens Island Apartments",
    "street": "1914 East 9400 South",
    "city": "Sandy",
    "state": "UT",
    "zip": "84093"
  }
}

Example Response

{
  "property": {
    "id": 1,
    "available": true,
    "kind": "multi_family",
    "name": "Queens Island Apartments",
    "street": "1914 East 9400 South",
    "city": "Sandy",
    "state": "UT",
    "zip": "84093",
    "invitation_only": false,
    "invitation_only_message": "",
    "application_url": "http://glacier.qlp.dev/d/apply/1",
    "form_preset_id": 1,
    "background_config_id": 151,
    "floor_plans": [
      {
        "id": 1,
        "property_id": 1,
        "name": "Queens Island Apartments",
        "beds": null,
        "baths": null,
        "deposit": null,
        "rent": null,
      }
    ]
  }
}

GET

/api/v2/properties/:property_id

Returns a property.

available boolean	If `true`, the online application form will accept applications for this property.
kind string	Possible values are `multi_family`, `single_family`, and `generic`.
name string	Example: Queens Island Apartments
street string	Example: 1914 East 9400 South
city string	Example: Sandy
state string	Example: UT
zip string	Example: 84093
invitation_only boolean	If `true`, the online application form will accept people with invitations.
invitation_only_message string	If an applicant arrives at an invitation only property without an invitation, this message will be presented to the applicant.
application_url string	The URL for the online application form for this property.
form_preset_id integer	The form preset selected for the property's online application form. The form preset defines the questions and disclosures presented to the applicant.
background_config_id integer	The background config selected for this property. The background config defines the background screening settings for this property including which screening package to order on the applicant.
floor_plans array	A list of floor_plans for the property. See the Floor Plans API for more information.

Example Response

{
  "property": {
    "id": 1,
    "available": true,
    "kind": "multi_family",
    "name": "Queens Island Apartments",
    "street": "1914 East 9400 South",
    "city": "Sandy",
    "state": "UT",
    "zip": "84093",
    "invitation_only": false,
    "invitation_only_message": "",
    "application_url": "http://glacier.qlp.dev/d/apply/1",
    "form_preset_id": 1,
    "background_config_id": 151,
    "floor_plans": [
      {
        "id": 2,
        "property_id": 1,
        "name": "Braeburn",
        "beds": 1,
        "baths": 1.5,
        "deposit": 400,
        "rent": 900
      },
      {
        "id": 1,
        "property_id": 1,
        "name": "Brandywine",
        "beds": 3,
        "baths": 1.75,
        "deposit": 500,
        "rent": 1200
      }
    ]
  }
}

DELETE

/api/v2/properties/:property_id

Deletes a property.

Example Response

{
  "property": {
    "id": 1,
    "available": true,
    "kind": "multi_family",
    "name": "Queens Island Apartments",
    "street": "1914 East 9400 South",
    "city": "Sandy",
    "state": "UT",
    "zip": "84093",
    "invitation_only": false,
    "invitation_only_message": "",
    "application_url": "http://glacier.qlp.dev/d/apply/1",
    "form_preset_id": 1,
    "background_config_id": 151,
    "floor_plans": [
      {
        "id": 2,
        "property_id": 1,
        "name": "Braeburn",
        "beds": 1,
        "baths": 1.5,
        "deposit": 400,
        "rent": 900
      },
      {
        "id": 1,
        "property_id": 1,
        "name": "Brandywine",
        "beds": 3,
        "baths": 1.75,
        "deposit": 500,
        "rent": 1200
      }
    ]
  }
}

While this action currently returns the deleted object, we may change that without notice.