v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Calendar Logs

Get calendar block logs

Retrieves a list of block logs based on the specified filters.

get/api/block-logs

Query parameters

listingIdstring
Example:66054019764cbb000f37c450

Filters the logs by the Guesty listing ID.

userNamestring
Example:John Doe

Filter logs based on the user who created the block.

startDatestring date
Example:2024-01-01

Filter logs based on the block's start date.

endDatestring date
Example:2024-02-01

Filter logs based on the block's end date.

blockType'manual' | 'preparation_time'

Filters logs by the type of block (manual or preparation_time).

eventType'created' | 'updated' | 'removed'

Filters logs by the event type (created, updated, removed).

Response

The record has been successfully fetched

propertyNamestring required

The name of the property associated with the log.

userNamestring required

The name of the user who made the changes.

startDatestring date required

The start date of the block.

endDatestring date required

The end date of the block.

blockTypestring required

The type of block applied.

eventType'BLOCK_CREATED' | 'BLOCK_UPDATED' | 'BLOCK_REMOVED' required

The event type related to the block.

notestring required

A note related to the block.

reason'Owner block' | 'Offboarded' | 'Migrated unit block' | 'Maintenance' | 'Onboarding' | 'Emergency out of order' | 'Do not sell' | 'Deactivated' | 'Other' required

The reason for the block.

doneAtstring date required

The date when the block action was completed.

Example response

[
  {
    "startDate": "2024-01-01",
    "endDate": "2024-01-01",
    "doneAt": "2024-01-11"
  }
]