Student.com public API API Reference

The Student.com API is organised around REST and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. You can find the swagger definition of the API here

API Endpoint

https://api.student.com/v1.4

Terms of Service: https://www.student.com/terms/terms-of-use

Contact: tech+api+support@student.com

Request Content-Types: application/json

Response Content-Types: application/json

Schemes: https

Version: 1.4

Cities

Get city feed

GET /cities

slugs: string

in query

Filter results by city slugs, query string with comma separated values.

page_size: string

in query

Size of each page in the response(maximum:20).

country_slug: string

in query

Filter results by country slug.

page_number: string

in query

Page number to request.

200 OK

CitiesResponse

200 response

400 Bad Request

ErrorResponse

400 response

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "cities": [
      {
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "name": "London",
        "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
        "slug": "london"
      }
    ],
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    }
  }
}

Response Example (400 Bad Request)

{
  "errors": [
    {
      "code": "parameter_missing",
      "message": "required field missing"
    }
  ],
  "status": "invalid request"
}

Countries

Get country feed

GET /countries

page_size: string

in query

Size of each page in the response(maximum:20).

page_number: string

in query

Page number to request.

200 OK

CountriesResponse

200 response

400 Bad Request

ErrorResponse

400 response

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    },
    "countries": [
      {
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "name": "London",
        "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
        "slug": "london"
      }
    ]
  }
}

Response Example (400 Bad Request)

{
  "errors": [
    {
      "code": "parameter_missing",
      "message": "required field missing"
    }
  ],
  "status": "invalid request"
}

Leads

Get lead feed

GET /leads

lead_ids: string

in query

Filter results by lead ids, query string with comma separated values.

page_size: string

in query

Size of each page in the response(maximum:20).

page_number: string

in query

Page number to request.

student_email: string

in query

Leads owned by this student email.

created_before: string

in query

Leads created before this date(YYYY-MM-DD).

created_after: string

in query

Leads created after this date(YYYY-MM-DD).

stage: string

in query

Leads stage to request, stage is enum values new,application_processing,in_consultation, completed,cancellation,lost,pay_through_scom

200 OK

LeadsResponse

200 response

400 Bad Request

ErrorResponse

400 response

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "leads": [
      {
        "stage": "new",
        "updated_at": "2021-02-24T00:00:00.000Z",
        "move_out_month": "2019-01",
        "student": {
          "email_address": "ann.smith@example.com",
          "last_name": "smith",
          "first_name": "john"
        },
        "budget_value": "500.50",
        "budget_frequency": "per-week",
        "move_in_month": "2018-01",
        "created_at": "2021-02-24T00:00:00.000Z",
        "destination_university_name": "University Collage London",
        "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
        "budget_currency": "gbp",
        "point_of_contact": {
          "email_address": "john.smith@example.com"
        }
      }
    ],
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    }
  }
}

Response Example (400 Bad Request)

{
  "errors": [
    {
      "code": "parameter_missing",
      "message": "required field missing"
    }
  ],
  "status": "invalid request"
}

Leads

Add a new lead

POST /leads

CreateLeadInput

Lead object to submit. Requires Student details - email_address, first_name, last_name. Please also provide either city_id OR property_id

Request Content-Types: application/json

Request Example

{
  "listing_id": "eyJ0eXBlIjoiTGlzdGluZyIsImlkIjozNTUyMH0==",
  "student": {
    "email_address": "ann.smith@example.com",
    "last_name": "Smith",
    "phone_number": "+4407457123123",
    "language": "zh-cn",
    "other_preferences": "I want a single room in a shared apartment. I would like to share my apartment mostly with girls.",
    "first_name": "Ann",
    "marketing_consent": true,
    "wechat_id": "yi_long_2016"
  },
  "budget_value": "500.50",
  "budget_frequency": "per-week",
  "move_in_month": "2018-01",
  "destination_university_name": "University Collage London",
  "tracking": {
    "utm_term": "term_x",
    "gclid": "je12uFzkX7142",
    "utm_campaign": "promotion123",
    "source_details": "api",
    "utm_medium": "SocialMedia",
    "source": "agent_or_partner",
    "ip_address": "192.169.1.1",
    "source_device": "browser",
    "utm_source": "Weibo",
    "utm_content": "content_y"
  },
  "property_id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
  "move_out_month": "2019-01",
  "referrer_name": "Jack Ma",
  "budget_currency": "gbp",
  "referrer_email": "jack.ma@example.com",
  "point_of_contact": {
    "email_address": "john.smith@example.com",
    "last_name": "Smith",
    "phone_number": "+4407457123124",
    "first_name": "John"
  },
  "city_id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTJ9"
}

200 OK

CreateLeadResponse

200 response

400 Bad Request

ErrorResponse

400 response

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "lead": {
      "stage": "new",
      "updated_at": "2021-02-24T00:00:00.000Z",
      "move_out_month": "2019-01",
      "student": {
        "email_address": "ann.smith@example.com",
        "last_name": "smith",
        "first_name": "john"
      },
      "budget_value": "500.50",
      "budget_frequency": "per-week",
      "move_in_month": "2018-01",
      "created_at": "2021-02-24T00:00:00.000Z",
      "destination_university_name": "University Collage London",
      "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
      "budget_currency": "gbp",
      "point_of_contact": {
        "email_address": "john.smith@example.com"
      }
    }
  },
  "status": "string"
}

Response Example (400 Bad Request)

{
  "errors": [
    {
      "code": "parameter_missing",
      "message": "required field missing"
    }
  ],
  "status": "invalid request"
}

Properties

Get property feed

GET /properties

city_slug: string

in query

Filter results by city slug.

slugs: string

in query

Filter results by property slugs, query string with comma separated values.

page_size: string

in query

Size of each page in the response(maximum:20).

country_slug: string

in query

Filter results by country slug.

page_number: string

in query

Page number to request

200 OK

PropertiesResponse

200 response

400 Bad Request

ErrorResponse

400 response

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "total_count": "integer",
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    },
    "properties": [
      {
        "unit_types": [
          {
            "images": [
              {
                "is_hero_image": true,
                "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
              }
            ],
            "bedroom_count_min": 1,
            "max_occupancy": 5,
            "room_size": "100-120",
            "room_size_unit": "sqft",
            "kitchen_count": 1,
            "bedroom_count_max": 3,
            "bed_count": 1,
            "bed_sizes": [
              {
                "bed_type": "double_bed",
                "length": 203,
                "width": 107,
                "bed_count": 10
              }
            ],
            "listings": [
              {
                "move_out_type": "anytime",
                "tenancy_length_value": "24-25",
                "available_to": "2019-01-01",
                "tenancy_length_type": "between,",
                "discount_value": 5,
                "move_out": null,
                "availability": "good",
                "move_in": "2018-01-01",
                "price_min": 400.5,
                "discount_type": "percentage",
                "move_in_type": "after",
                "available_from": "2018-01-01",
                "id": "eyJ0eXBlIjoiTGlzdGluZyIsImlkIjo0NDc3OX0==",
                "price_max": 400.5
              }
            ],
            "floors": [
              0,
              1,
              2
            ],
            "room_arrangement": "cluster",
            "gender_mix": "mixed",
            "name": "deluxe suite",
            "id": "eyJ0eXBlIjoiVW5pdFR5cGUiLCJpZCI6MTY3NzN9",
            "bathroom_type": "private_ensuite",
            "category": "shared_room",
            "bathroom_count": 1,
            "facilities": [
              {
                "name": "Wifi",
                "label": "Free",
                "slug": "wifi_free",
                "tags": [
                  [
                    "bills",
                    "include"
                  ]
                ]
              }
            ]
          }
        ],
        "total_beds": 100,
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "images": [
          {
            "is_hero_image": true,
            "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
          }
        ],
        "address": "Canal Reach, Kings Cross, London",
        "city": {
          "country": {
            "name": "United Kingdom",
            "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
            "slug": "uk"
          },
          "name": "London",
          "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
          "slug": "london"
        },
        "latitude": "38.396",
        "description": "Grab a luxe pad in up-and-coming trendy hotspot Kings Cross a perfect entry point for experiencing London",
        "booking_journey": "manual",
        "no_place_no_pay": true,
        "post_code": "N1C 4BE",
        "name": "Urbanest King's Cross",
        "property_type": "apartments",
        "no_visa_no_pay": true,
        "currency": "gbp",
        "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ=="
      }
    ]
  }
}

Response Example (400 Bad Request)

{
  "errors": [
    {
      "code": "parameter_missing",
      "message": "required field missing"
    }
  ],
  "status": "invalid request"
}

Universities

Get university feed

GET /universities

city_slug: string

in query

Filter results by city slug.

slugs: string

in query

Filter results by university slugs, query string with comma separated values.

page_size: string

in query

Size of each page in the response(maximum:20).

page_number: string

in query

Page number to request.

200 OK

UniversitiesResponse

200 response

400 Bad Request

ErrorResponse

400 response

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "universities": [
      {
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "address": "Sussex Place",
        "city": {
          "country": {
            "name": "United Kingdom",
            "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
            "slug": "uk"
          },
          "name": "London",
          "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
          "slug": "london"
        },
        "latitude": 51.5263,
        "name": "London Business School",
        "id": "eyJ0eXBlIjoiVW5pdmVyc2l0eSIsImlkIjo0MTR9",
        "slug": "london-business-school",
        "longitude": -0.160998
      }
    ],
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    }
  }
}

Response Example (400 Bad Request)

{
  "errors": [
    {
      "code": "parameter_missing",
      "message": "required field missing"
    }
  ],
  "status": "invalid request"
}

Schema Definitions

Tracking: object

utm_term: string
gclid: string
utm_campaign: string
source_details: string
utm_medium: string
source: string
ip_address: string
source_device: string
utm_source: string
utm_content: string

Example

{
  "utm_term": "term_x",
  "gclid": "je12uFzkX7142",
  "utm_campaign": "promotion123",
  "source_details": "api",
  "utm_medium": "SocialMedia",
  "source": "agent_or_partner",
  "ip_address": "192.169.1.1",
  "source_device": "browser",
  "utm_source": "Weibo",
  "utm_content": "content_y"
}

UniversitiesResponse: object

data: object
universities: University University page_info: PageInfo

Example

{
  "data": {
    "universities": [
      {
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "address": "Sussex Place",
        "city": {
          "country": {
            "name": "United Kingdom",
            "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
            "slug": "uk"
          },
          "name": "London",
          "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
          "slug": "london"
        },
        "latitude": 51.5263,
        "name": "London Business School",
        "id": "eyJ0eXBlIjoiVW5pdmVyc2l0eSIsImlkIjo0MTR9",
        "slug": "london-business-school",
        "longitude": -0.160998
      }
    ],
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    }
  }
}

City: object

country: Country
name: string
id: Id
slug: string

Example

{
  "country": {
    "name": "United Kingdom",
    "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
    "slug": "uk"
  },
  "name": "London",
  "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
  "slug": "london"
}

CountriesResponse: object

data: object
page_info: PageInfo countries: City City

Example

{
  "data": {
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    },
    "countries": [
      {
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "name": "London",
        "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
        "slug": "london"
      }
    ]
  }
}

Image: object

is_hero_image: boolean
url: string

Example

{
  "is_hero_image": true,
  "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
}

Student: object

email_address: string
last_name: string
phone_number: string
language: string
other_preferences: string
first_name: string
marketing_consent: boolean
wechat_id: object

Example

{
  "email_address": "ann.smith@example.com",
  "last_name": "Smith",
  "phone_number": "+4407457123123",
  "language": "zh-cn",
  "other_preferences": "I want a single room in a shared apartment. I would like to share my apartment mostly with girls.",
  "first_name": "Ann",
  "marketing_consent": true,
  "wechat_id": "yi_long_2016"
}

ErrorResponse: object

errors: ErrorMessage
ErrorMessage
status: string

Example

{
  "errors": [
    {
      "code": "parameter_missing",
      "message": "required field missing"
    }
  ],
  "status": "invalid request"
}

PageInfo: object

has_previous_page: boolean
has_next_page: boolean
num_pages: integer

Example

{
  "has_previous_page": true,
  "has_next_page": false,
  "num_pages": 10
}

PropertiesResponse: object

data: object
total_count: integer page_info: PageInfo properties: Property Property

Example

{
  "data": {
    "total_count": "integer",
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    },
    "properties": [
      {
        "unit_types": [
          {
            "images": [
              {
                "is_hero_image": true,
                "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
              }
            ],
            "bedroom_count_min": 1,
            "max_occupancy": 5,
            "room_size": "100-120",
            "room_size_unit": "sqft",
            "kitchen_count": 1,
            "bedroom_count_max": 3,
            "bed_count": 1,
            "bed_sizes": [
              {
                "bed_type": "double_bed",
                "length": 203,
                "width": 107,
                "bed_count": 10
              }
            ],
            "listings": [
              {
                "move_out_type": "anytime",
                "tenancy_length_value": "24-25",
                "available_to": "2019-01-01",
                "tenancy_length_type": "between,",
                "discount_value": 5,
                "move_out": null,
                "availability": "good",
                "move_in": "2018-01-01",
                "price_min": 400.5,
                "discount_type": "percentage",
                "move_in_type": "after",
                "available_from": "2018-01-01",
                "id": "eyJ0eXBlIjoiTGlzdGluZyIsImlkIjo0NDc3OX0==",
                "price_max": 400.5
              }
            ],
            "floors": [
              0,
              1,
              2
            ],
            "room_arrangement": "cluster",
            "gender_mix": "mixed",
            "name": "deluxe suite",
            "id": "eyJ0eXBlIjoiVW5pdFR5cGUiLCJpZCI6MTY3NzN9",
            "bathroom_type": "private_ensuite",
            "category": "shared_room",
            "bathroom_count": 1,
            "facilities": [
              {
                "name": "Wifi",
                "label": "Free",
                "slug": "wifi_free",
                "tags": [
                  [
                    "bills",
                    "include"
                  ]
                ]
              }
            ]
          }
        ],
        "total_beds": 100,
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "images": [
          {
            "is_hero_image": true,
            "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
          }
        ],
        "address": "Canal Reach, Kings Cross, London",
        "city": {
          "country": {
            "name": "United Kingdom",
            "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
            "slug": "uk"
          },
          "name": "London",
          "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
          "slug": "london"
        },
        "latitude": "38.396",
        "description": "Grab a luxe pad in up-and-coming trendy hotspot Kings Cross a perfect entry point for experiencing London",
        "booking_journey": "manual",
        "no_place_no_pay": true,
        "post_code": "N1C 4BE",
        "name": "Urbanest King's Cross",
        "property_type": "apartments",
        "no_visa_no_pay": true,
        "currency": "gbp",
        "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
        "billing_cycle": "weekly"
      }
    ]
  }
}

CitiesResponse: object

data: object
cities: City City page_info: PageInfo

Example

{
  "data": {
    "cities": [
      {
        "country": {
          "name": "United Kingdom",
          "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
          "slug": "uk"
        },
        "name": "London",
        "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
        "slug": "london"
      }
    ],
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    }
  }
}

PointOfContact: object

email_address: string
last_name: string
phone_number: string
first_name: string

Example

{
  "email_address": "john.smith@example.com",
  "last_name": "Smith",
  "phone_number": "+4407457123124",
  "first_name": "John"
}

University: object

country: Country
address: string
city: City
latitude: string
name: string
id: Id
slug: string
longitude: string

Example

{
  "country": {
    "name": "United Kingdom",
    "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
    "slug": "uk"
  },
  "address": "Sussex Place",
  "city": {
    "country": {
      "name": "United Kingdom",
      "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
      "slug": "uk"
    },
    "name": "London",
    "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
    "slug": "london"
  },
  "latitude": 51.5263,
  "name": "London Business School",
  "id": "eyJ0eXBlIjoiVW5pdmVyc2l0eSIsImlkIjo0MTR9",
  "slug": "london-business-school",
  "longitude": -0.160998
}

CreateLeadResponse: object

data: object
lead: Lead
status: string

Example

{
  "data": {
    "lead": {
      "stage": "new",
      "updated_at": "2021-02-24T00:00:00.000Z",
      "move_out_month": "2019-01",
      "student": {
        "email_address": "ann.smith@example.com",
        "last_name": "smith",
        "first_name": "john"
      },
      "budget_value": "500.50",
      "budget_frequency": "per-week",
      "move_in_month": "2018-01",
      "created_at": "2021-02-24T00:00:00.000Z",
      "destination_university_name": "University Collage London",
      "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
      "budget_currency": "gbp",
      "point_of_contact": {
        "email_address": "john.smith@example.com"
      }
    }
  },
  "status": "string"
}

Listing: object

move_out_type: string exactly_match, before, anytime
tenancy_length_value: string ((^\d+-\d+$)|(^\d+\+?$))
available_to: string (date)
tenancy_length_type: string equal, no_less_than, no_more_than, between, not_specific
discount_value: number
move_out: string (date)
availability: string good, limited, sold_out
move_in: string (date)
price_min: number
discount_type: string absolute, percentage
move_in_type: string exactly_match, after, anytime
available_from: string (date)
id: Id
price_max: number

Example

{
  "move_out_type": "anytime",
  "tenancy_length_value": "24-25",
  "available_to": "2019-01-01",
  "tenancy_length_type": "between,",
  "discount_value": 5,
  "move_out": null,
  "availability": "good",
  "move_in": "2018-01-01",
  "price_min": 400.5,
  "discount_type": "percentage",
  "move_in_type": "after",
  "available_from": "2018-01-01",
  "id": "eyJ0eXBlIjoiTGlzdGluZyIsImlkIjo0NDc3OX0==",
  "price_max": 400.5
}

UnitType: object

images: Image
Image
bedroom_count_min: integer
max_occupancy: integer
room_size: string
room_size_unit: string sqft, sqm
kitchen_count: number
bedroom_count_max: integer
bed_count: integer
bed_sizes: BedSize
BedSize
listings: Listing
Listing
floors: integer[]
integer
room_arrangement: string cluster, apartment, hotel_style
gender_mix: string mixed, male_only, female_only
name: string
id: Id
bathroom_type: string private_ensuite, private_non_ensuite, shared_ensuite, shared_non_ensuite, mixed
category: string entire_place, private_room, shared_room
bathroom_count: number
facilities: Facility
Facility

Example

{
  "images": [
    {
      "is_hero_image": true,
      "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
    }
  ],
  "bedroom_count_min": 1,
  "max_occupancy": 5,
  "room_size": "100-120",
  "room_size_unit": "sqft",
  "kitchen_count": 1,
  "bedroom_count_max": 3,
  "bed_count": 1,
  "bed_sizes": [
    {
      "bed_type": "double_bed",
      "length": 203,
      "width": 107,
      "bed_count": 10
    }
  ],
  "listings": [
    {
      "move_out_type": "anytime",
      "tenancy_length_value": "24-25",
      "available_to": "2019-01-01",
      "tenancy_length_type": "between,",
      "discount_value": 5,
      "move_out": null,
      "availability": "good",
      "move_in": "2018-01-01",
      "price_min": 400.5,
      "discount_type": "percentage",
      "move_in_type": "after",
      "available_from": "2018-01-01",
      "id": "eyJ0eXBlIjoiTGlzdGluZyIsImlkIjo0NDc3OX0==",
      "price_max": 400.5
    }
  ],
  "floors": [
    0,
    1,
    2
  ],
  "room_arrangement": "cluster",
  "gender_mix": "mixed",
  "name": "deluxe suite",
  "id": "eyJ0eXBlIjoiVW5pdFR5cGUiLCJpZCI6MTY3NzN9",
  "bathroom_type": "private_ensuite",
  "category": "shared_room",
  "bathroom_count": 1,
  "facilities": [
    {
      "name": "Wifi",
      "label": "Free",
      "slug": "wifi_free",
      "tags": [
        [
          "bills",
          "include"
        ]
      ]
    }
  ]
}

Lead: object

stage: string new, application_processing, in_consultation, completed, cancellation, lost, pay_through_scom: lead status
updated_at: string (dateTime)
move_out_month: string
student: object
email_address: string last_name: string first_name: string
budget_value: string
budget_frequency: string per-week, per-month
move_in_month: string
created_at: string (dateTime)
destination_university_name: string
id: Id
budget_currency: string
point_of_contact: object
email_address: string

Example

{
  "stage": "new",
  "updated_at": "2021-02-24T00:00:00.000Z",
  "move_out_month": "2019-01",
  "student": {
    "email_address": "ann.smith@example.com",
    "last_name": "smith",
    "first_name": "john"
  },
  "budget_value": "500.50",
  "budget_frequency": "per-week",
  "move_in_month": "2018-01",
  "created_at": "2021-02-24T00:00:00.000Z",
  "destination_university_name": "University Collage London",
  "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
  "budget_currency": "gbp",
  "point_of_contact": {
    "email_address": "john.smith@example.com"
  }
}

Country: object

name: string
id: Id
slug: string

Example

{
  "name": "United Kingdom",
  "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
  "slug": "uk"
}

Id: string

LeadsResponse: object

data: object
leads: Lead Lead page_info: PageInfo

Example

{
  "data": {
    "leads": [
      {
        "stage": "new",
        "updated_at": "2021-02-24T00:00:00.000Z",
        "move_out_month": "2019-01",
        "student": {
          "email_address": "ann.smith@example.com",
          "last_name": "smith",
          "first_name": "john"
        },
        "budget_value": "500.50",
        "budget_frequency": "per-week",
        "move_in_month": "2018-01",
        "created_at": "2021-02-24T00:00:00.000Z",
        "destination_university_name": "University Collage London",
        "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
        "budget_currency": "gbp",
        "point_of_contact": {
          "email_address": "john.smith@example.com"
        }
      }
    ],
    "page_info": {
      "has_previous_page": true,
      "has_next_page": false,
      "num_pages": 10
    }
  }
}

Facility: object

name: string
label: string
slug: string
tags: string[]
string amenity, security, rule, bills, include, not_include, no_service

Example

{
  "name": "Wifi",
  "label": "Free",
  "slug": "wifi_free",
  "tags": [
    [
      "bills",
      "include"
    ]
  ]
}

ErrorMessage: object

code: string
message: string

Example

{
  "code": "parameter_missing",
  "message": "required field missing"
}

Property: object

unit_types: UnitType

UnitType

total_beds: integer

country: Country

images: Image

Image

address: string

city: City

latitude: string

description: string

booking_journey: string manual, semi_automatic, full_automatic

no_place_no_pay: boolean

A booking can be cancelled for free if you have failed to obtain the required qualifications to get info you university of choice

post_code: string

name: string

property_type: string co-living, apartments, hmo, house-share, home-stay, student-residence-halls, dormitory, purpose-built-student-accommodation, house, hostel, hotel, apart-hotel, multifamily, lodge, condos, townhouse-home, bungalow, terrace, villa, serviced-apartment, duplex

co-living: Co-living is a modern form of communal living in which residents get a private apartment in a furnished property with shared facilities and common areas. Co-living is popular in major cities as a means of affordable living for students and young professionals.
apartments: A suite of rooms forming one residence; a flat.
hmo: UK only - house in Multiple Occupation, a house or other dwelling in which several different households are living, sharing facilities such as a kitchen or bathroom.
house-share: Two or more people living in accommodation together. Often large house or apartment. Usually each person will have their own bedroom and typically they will share certain communal areas such as kitchens, bathrooms or living rooms.
home-stay: A room in the family host home.
student-residence-halls: A college or university building containing living quarters for students.
dormitory: A large bedroom for a number of people in a school or institution.
purpose-built-student-accommodation: Housing specifically built for university students by private developers. Properties usually take one of two forms: 1. Self contained studio or “cluster” flats with private kitchens but shared living space.
house: A building for human habitation, especially one that consists of a ground floor and one or more upper storeys.
hostel: Student hostel, Youth Hostel, backpackers, often sharing a room with multiple people, also has option to have private room with ensuite or shared bathroom, can be mixed gender or gender specific room types, not restricted to only student residents, can be offered with or without breakfast.
hotel: Hotel (can have local star rating), can be offered with or without breakfast or dinner, not restricted to only student residents.
apart-hotel: Serviced apartment (self contained hotel rooms), professional short stay apartments to be rented by apartment not room, not exclusive to only student residents, have facilities and services such as a reception desk and restaurant.
multifamily: Classification of housing where multiple separate housing units for residential inhabitants are contained within one building or several buildings within one complex, mostly common within United States. Not restricted to only student residents.
lodge: An often rustic building used as a short term accomodation much like a hotel but of older style - a lodge may have communal facilities,can be offered with or without breakfast.
condos: An apartment building in which each apartment is owned separately by the people living in it, but also containing shared areas.
townhouse-home: A townhouse is a type of terraced housing, one of a row of similar houses that are usually joined by a shared wall. A modern townhouse is often one with a small footprint on multiple floors.
bungalow: Free standing small house that is either single-storey or has a second storey built into a sloping roof, and may be surrounded by wide verandas.
terrace: One property in a row of houses that are joined together. Commonly found in inner city locations
villa: A house, usually in the countryside or near the sea, especially in southern Europe, and often one that people can rent for a holiday.
serviced-apartment: A serviced apartment is a fully furnished apartment available for short-term or long-term stay, providing hotel-like amenities such as room service, and professional house keeping services.
duplex: A residential building divided into two apartments, each with its own entrance.

no_visa_no_pay: boolean

Your booking can be cancelled for free if the Visa application has been denied

currency: string (^[a-z]{3}$)

id: Id

billing_cycle: string weekly, monthly

state: string available_with_price, available, coming_soon, sold_out, inactive

facilities: Facility

Facility

headline: string

slug: string

longitude: string

Example

{
  "unit_types": [
    {
      "images": [
        {
          "is_hero_image": true,
          "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
        }
      ],
      "bedroom_count_min": 1,
      "max_occupancy": 5,
      "room_size": "100-120",
      "room_size_unit": "sqft",
      "kitchen_count": 1,
      "bedroom_count_max": 3,
      "bed_count": 1,
      "bed_sizes": [
        {
          "bed_type": "double_bed",
          "length": 203,
          "width": 107,
          "bed_count": 10
        }
      ],
      "listings": [
        {
          "move_out_type": "anytime",
          "tenancy_length_value": "24-25",
          "available_to": "2019-01-01",
          "tenancy_length_type": "between,",
          "discount_value": 5,
          "move_out": null,
          "availability": "good",
          "move_in": "2018-01-01",
          "price_min": 400.5,
          "discount_type": "percentage",
          "move_in_type": "after",
          "available_from": "2018-01-01",
          "id": "eyJ0eXBlIjoiTGlzdGluZyIsImlkIjo0NDc3OX0==",
          "price_max": 400.5
        }
      ],
      "floors": [
        0,
        1,
        2
      ],
      "room_arrangement": "cluster",
      "gender_mix": "mixed",
      "name": "deluxe suite",
      "id": "eyJ0eXBlIjoiVW5pdFR5cGUiLCJpZCI6MTY3NzN9",
      "bathroom_type": "private_ensuite",
      "category": "shared_room",
      "bathroom_count": 1,
      "facilities": [
        {
          "name": "Wifi",
          "label": "Free",
          "slug": "wifi_free",
          "tags": [
            [
              "bills",
              "include"
            ]
          ]
        }
      ]
    }
  ],
  "total_beds": 100,
  "country": {
    "name": "United Kingdom",
    "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
    "slug": "uk"
  },
  "images": [
    {
      "is_hero_image": true,
      "url": "https://image.student.com/max_1280x1280/property-64469-630eac2146fbe7995d1fb7d09eb23444.jpeg"
    }
  ],
  "address": "Canal Reach, Kings Cross, London",
  "city": {
    "country": {
      "name": "United Kingdom",
      "id": "eyJ0eXBlIjoiQ291bnRyeSIsImlkIjozfQ==",
      "slug": "uk"
    },
    "name": "London",
    "id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTd9",
    "slug": "london"
  },
  "latitude": "38.396",
  "description": "Grab a luxe pad in up-and-coming trendy hotspot Kings Cross a perfect entry point for experiencing London",
  "booking_journey": "manual",
  "no_place_no_pay": true,
  "post_code": "N1C 4BE",
  "name": "Urbanest King's Cross",
  "property_type": "apartments",
  "no_visa_no_pay": true,
  "currency": "gbp",
  "id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
  "billing_cycle": "weekly",
  "state": "available_with_price",
  "facilities": [
    {
      "name": "Wifi",
      "label": "Free",
      "slug": "wifi_free",
      "tags": [
        [
          "bills",
          "include"
        ]
      ]
    }
  ],
  "headline": "This is a property headline"
}

CreateLeadInput: object

listing_id: string
student: Student
budget_value: string
budget_frequency: string per-week, per-month
move_in_month: string
destination_university_name: string
tracking: Tracking
property_id: string
move_out_month: string
referrer_name: string
budget_currency: string
referrer_email: string
point_of_contact: PointOfContact
city_id: string

Example

{
  "listing_id": "eyJ0eXBlIjoiTGlzdGluZyIsImlkIjozNTUyMH0==",
  "student": {
    "email_address": "ann.smith@example.com",
    "last_name": "Smith",
    "phone_number": "+4407457123123",
    "language": "zh-cn",
    "other_preferences": "I want a single room in a shared apartment. I would like to share my apartment mostly with girls.",
    "first_name": "Ann",
    "marketing_consent": true,
    "wechat_id": "yi_long_2016"
  },
  "budget_value": "500.50",
  "budget_frequency": "per-week",
  "move_in_month": "2018-01",
  "destination_university_name": "University Collage London",
  "tracking": {
    "utm_term": "term_x",
    "gclid": "je12uFzkX7142",
    "utm_campaign": "promotion123",
    "source_details": "api",
    "utm_medium": "SocialMedia",
    "source": "agent_or_partner",
    "ip_address": "192.169.1.1",
    "source_device": "browser",
    "utm_source": "Weibo",
    "utm_content": "content_y"
  },
  "property_id": "eyJ0eXBlIjoiUHJvcGVydHkiLCJpZCI6Mjc2fQ==",
  "move_out_month": "2019-01",
  "referrer_name": "Jack Ma",
  "budget_currency": "gbp",
  "referrer_email": "jack.ma@example.com",
  "point_of_contact": {
    "email_address": "john.smith@example.com",
    "last_name": "Smith",
    "phone_number": "+4407457123124",
    "first_name": "John"
  },
  "city_id": "eyJ0eXBlIjoiQ2l0eSIsImlkIjo0MTJ9"
}

BedSize: object

bed_type: string single_bed, double_bed, small_double_bed, king_bed, king_single_bed, california_king_bed, grand_king_bed, queen_bed, twin_bed, bunk_bed, king_size_bed
length: number
width: number
bed_count: number

Example

{
  "bed_type": "double_bed",
  "length": 203,
  "width": 107,
  "bed_count": 10
}

Documentation by Spectacle