Views

List saved views

Changed on

Retrieve all your saved listing or reservation views. The section query parameter is required; a request without it is rejected with 400. Results combine your account's own views with Guesty's predefined ones, and are paginated — limit defaults to 25 and is capped at 100.

get/views

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/views
  • Auth
    API key in header authorization

Query parameters

sectionstring required
Example:listings

One of listings, reservations

fieldsstring
Example:"title"

Selection of fields, separated by space. When null retrieves all object.

limitnumber
Example:25

Pagination

skipnumber

Pagination

Response

Views Array

_idstring

Unique id

accountIdstring

Id of the user owning this view

titlestring

Title for the view

fieldsstring

Selection of fields, separated by space

sortstring

ascending sort, use '-' for descending sort

createdAtstring date-time

Timestamp when the view was created.

updatedAtstring date-time

Timestamp when the view was last updated.

Example response

[
  {
    "scheduledEmails": [
      {
        "days": [
          4
        ],
        "hour": 14
      }
    ],
    "shares": [
      {
        "contactId": "5926bdfb1bfe871000d0a745"
      }
    ]
  }
]

Changes