Guestfolio API Documentation

« back to overview

Users [1.1]

User accounts setup within and with access to the Guestfolio application

index

Get the list of users for a hotel

URL

GET /api/hotels/:id/users

Optional Parameters

  • page String

    Page number requested
  • per_page String

    Results to be shown per page

Response Object

  • Array of user details

Examples

Request Response

{

"total_count": 3,
"total_pages": 3,
"users": [
    {
        "id": 2,
        "first_name": "First",
        "last_name": "Last",
        "username": "Username",
        "email": "email@address.com",
        "role": "Manager",
        "sign_in_count": 50,
        "settings": {
            "request_report_type": "itinerary",
            "request_report_frequency": 3600,
            "arrival_report": "06:00:00"
        },
        "_links": {
            "self": {
                "href": "https://guestfolio.net/api/hotels/1/users/1"
            }
        }
    }
"_links": {
    "self": {
        "href": "https://guestfolio.net/api/hotels/1/users?page=2"
    }
    "previous": {
        "href": "https://guestfolio.net/api/hotels/1/users?page=1"
    }
    "next": {
        "href": "https://guestfolio.net/api/hotels/1/users?page=3"
    }
}

}

The users array includes a hash of basic user information and links to additional associated permitted API resources

create

Create a new user

URL

POST /api/hotels/:id/users

Required Parameters

  • username String
  • email String
  • password String
  • role String

Optional Parameters

  • first_name String
  • last_name String
  • settings Hash

    Any report settings

Response Object

  • Hash

    The user details

Examples

Request

{

"first_name": "First",
"last_name": "Last",
"username": "Username",
"password": "Password",
"email": "email@address.com",
"role": "Frontdesk",
"settings": {
    "request_report_type": "itinerary",
    "request_report_frequency": 3600,
    "arrival_report": "06:00:00"
}

}

 Response

{

"id": "3",
"first_name": "First",
"last_name": "Last",
"username": "Username",
"email": "email@address.com",
"sign_in_count": 0,
"role": "Frontdesk",
"settings": {
    "request_report_type": "itinerary",
    "request_report_frequency": 3600,
    "arrival_report": "06:00:00"
},
"_links": {
    "self": {
        "href": "https://guestfolio.net/api/hotels/1/users/3"
    }
}

}

show

Get a specific users details

URL

GET /api/hotels/:id/users/:id

Response Object

  • The user details

Examples

Request Response

{

"id": 1,
"first_name": "First",
"last_name": "Last",
"username": "Username",
"email": "email@address.com",
"role": "Manager",
"created_at": "2012-12-13T10:20:50-08:00",
"updated_at": "2012-12-15T12:18:26-08:00",
"_links": {
    "self": {
        "href": "https://guestfolio.net/api/hotels/1/users/1"
    }
}

}

The user hash includes full account information and links to additional associated API methods

update

Update an existing user with specific changed attributes

URL

PUT /api/hotels/:id/users/:id

Optional Parameters

  • username String
  • email String
  • password String
  • role String
  • first_name String
  • last_name String
  • settings Hash

    Any report settings

Response Object

  • String

    Empty string on success, check response code

Examples

Request 

"first_name": "New First",
"last_name": "New Last",
"password": "Password"

 Response

destroy

Delete an existing user

URL

DELETE /api/hotels/:id/users/:id