Guestfolio API Documentation

« back to overview

Surveys [1.1]

The survey resources all hotel survey

index

Get the list of surveys for a hotel

URL

GET /api/hotels/:id/surveys

Optional Parameters

  • page String

    Page number requested
  • per_page String

    Results to be shown per page

Response Object

  • Array of survey details

show

Get a specific survey details and response sets

URL

GET /api/hotels/:id/surveys/:id

Response Object

  • The survey details and response sets

Examples

Request Response

{

"id": 1,
"title": "Hotel Survey",
"score_goal": 80,
"active_at": "2012-12-01T08:00:00-08:00",
"inactive_at": null,
"created_at": "2012-12-13T10:20:50-08:00",
"updated_at": "2012-12-15T12:18:26-08:00",
"response_sets": [
  {
    "survey_id": 1,
    "reservation_id": 1,
    "score": 90,
    "started_at": "2013-01-05T15:19:05-08:00",
    "completed_at": "2013-01-025T15:19:11-08:00",
    "_links": {
        "self": {
            "href": "https://guestfolio.net/api/hotels/1/surveys/1/response-sets/1"
        },
        "reservation": {
           "href": "https://guestfolio.net/api/hotels/1/reservations/1"
        }
        "survey": {
           "href": "https://guestfolio.net/api/hotels/1/surveys/1"
        }
    }
  }
],
"_links": {
    "self": {
        "href": "https://guestfolio.net/api/hotels/1/surveys/1"
     },
    "response_sets": {
        "href": "https://guestfolio.net/api/hotels/1/surveys/1/response-sets"
     },
 }

}

The survey hash includes full survey information, basic response set information and links to additional associated permitted API resources