GUguesty
User scope

Get scope

Returns the current scope of permitted properties assigned to the specified user.

get/user-scope/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/user-scope/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

The unique identifier of the user whose scope is being retrieved.

Response

Scope retrieved successfully

allAssignedboolean

True if the user is scoped to all listings in the account. When true, listingIds will not be present.

listingIdsstring[]

Array of listing IDs that the user is scoped to. Only present when allAssigned is false or undefined. Note: Either allAssigned or listingIds will always be present.

Changes

No recorded changes to this operation across all 2 revisions of this API.