# Breezeway Documentation

> Documentation for Breezeway

## Guides
- [Getting Started with Breezeway's API](https://developer.breezeway.io/docs/getting-started.md): This page will help you get started with Breezeway's API.
- [Obtaining Credentials](https://developer.breezeway.io/docs/obtaining-credentials.md): You will need an active Breezeway account and API keys to send requests and receive responses.
- [Authentication](https://developer.breezeway.io/docs/authentication.md)
- [Cross-Company Access](https://developer.breezeway.io/docs/cross-company-accounts.md): Discover how to use a single set of API keys to access multiple companies
- [Subscribing to Webhook Events](https://developer.breezeway.io/docs/subscribing-to-webhooks.md)
- [Tasks](https://developer.breezeway.io/docs/task-webhooks.md)
- [Property Status](https://developer.breezeway.io/docs/property-status.md)

## API Reference
- [Obtain tokens](https://developer.breezeway.io/reference/obtain-tokens.md): The endpoint to generate an access token has a rate limit of 1 req/min. As these tokens are valid for 24 hours, there is no need to make requests for each request.  When the rate limit is hit, we will return HTTP status 429, and information about when the limit expires will be provided in both the header and the response body.
- [Refresh tokens](https://developer.breezeway.io/reference/refresh-tokens.md): Include your _refresh token_ in the authorization header to obtain new tokens  The endpoint to refresh an access token has a rate limit of 1 req/min. As these tokens are valid for 24 hours, there is no need to make requests for each request.  When the rate limit is hit, we will return HTTP status 429, and information about when the limit expires will be provided in both the header and the response body.
- [List properties](https://developer.breezeway.io/reference/list-properties.md)
- [Retrieve property](https://developer.breezeway.io/reference/retrieve-property.md)
- [Create property](https://developer.breezeway.io/reference/create-property.md)
- [Update property](https://developer.breezeway.io/reference/update-property.md)
- [Increase bedroom/bathroom count](https://developer.breezeway.io/reference/update-bedroombathroom.md): Add (and only add) bedrooms and/or bathrooms to a property
- [Delete Home](https://developer.breezeway.io/reference/delete-home.md): Property has it status set to `deleted` with removal of external id and any integration connection.
- [List available property tags](https://developer.breezeway.io/reference/list-available-property-tags.md): List property tags configured for a Breezeway company; creation of company tags must be performed within the app
- [Add tags for property](https://developer.breezeway.io/reference/add-tags-for-property.md)
- [Update tags for property](https://developer.breezeway.io/reference/update-tags-for-property.md)
- [Delete tags for property](https://developer.breezeway.io/reference/delete-tags-for-property.md): Return value indicates the tags remaining for property
- [Update property default photo](https://developer.breezeway.io/reference/update-property-default-photo.md)
- [List property contacts](https://developer.breezeway.io/reference/list-property-contacts.md): List property tags configured for a Breezeway company; creation of company tags must be performed within the app
- [Retrieve property contact](https://developer.breezeway.io/reference/retrieve-property-contact.md): Retrieve property contact
- [Create property contact](https://developer.breezeway.io/reference/create-property-contact.md): Create property contact for a Breezeway property
- [Delete property contact](https://developer.breezeway.io/reference/delete-property-contact.md): Delete property contact
- [Update property contact](https://developer.breezeway.io/reference/update-property-contact.md): Update property contact
- [List properties](https://developer.breezeway.io/reference/list-properties-by-external-id.md)
- [Retrieve property](https://developer.breezeway.io/reference/retrieve-property-by-external-id.md)
- [Create/update property](https://developer.breezeway.io/reference/create-update-property-by-external-id.md)
- [Update property external ID](https://developer.breezeway.io/reference/update-property-external-id.md): Update the external reference ID for a Breezeway property
- [List property contacts](https://developer.breezeway.io/reference/list-property-contacts-external-id.md): List property contacts configured for a Breezeway property
- [Retrieve property contact](https://developer.breezeway.io/reference/retrieve-property-contact-exterrnal-id.md): Retrieve property contact
- [Create property contact](https://developer.breezeway.io/reference/create-property-contact-external-id.md): Create property contact for a Breezeway property
- [Update property contact](https://developer.breezeway.io/reference/update-property-contact-external-id.md): Update property contact
- [Delete property contact](https://developer.breezeway.io/reference/delete-property-contact-external-id.md): Delete property contact
- [List reservations](https://developer.breezeway.io/reference/list-reservations.md)
- [Retrieve reservation](https://developer.breezeway.io/reference/retrieve-reservation.md)
- [Create reservation](https://developer.breezeway.io/reference/create-reservation.md)
- [Update reservation](https://developer.breezeway.io/reference/update-reservation.md): When reservation moves from one property to another, the original reservation needs to be deleted and a new one created to properly support internal processes.
- [Delete reservation](https://developer.breezeway.io/reference/delete-reservation.md): Remove active reservations from Breezeway system
- [List available reservation tags](https://developer.breezeway.io/reference/list-available-reservation-tags.md): List reservation tags configured for a Breezeway company
- [Create reservation tag](https://developer.breezeway.io/reference/create-reservation-tag.md): Create a company-level reservation tag; the tag can be referenced when creating or updating reservations
- [Retrieve tags for reservation](https://developer.breezeway.io/reference/retrieve-tags-for-reservation.md)
- [Delete tag for reservation](https://developer.breezeway.io/reference/delete-tag-for-reservation.md): Remove an individual tag associated with a specific reservation
- [Retrieve tasks linked to reservation](https://developer.breezeway.io/reference/retrieve-tasks-linked-to-reservation.md): Retrieves all tasks linked to specified reservation
- [Add task link to reservation](https://developer.breezeway.io/reference/add-task-link-to-reservation.md): Link an existing task to a reservation
- [Delete task link to reservation](https://developer.breezeway.io/reference/delete-task-link-to-reservation.md): Remove link between task and reservation
- [Reservation Check In](https://developer.breezeway.io/reference/reservation-check-in.md)
- [Reservation Check Out](https://developer.breezeway.io/reference/reservation-check-out.md)
- [List reservations](https://developer.breezeway.io/reference/list-reservations-by-external-id.md)
- [Retrieve reservation](https://developer.breezeway.io/reference/retrieve-reservation-by-external-id.md)
- [Create/update reservation](https://developer.breezeway.io/reference/create-update-reservation-by-external-id.md)
- [List tasks](https://developer.breezeway.io/reference/list-tasks.md): Use this endpoint to retrieve all tasks for a specified property. When retrieving multiple tasks, include only one of the following path parameters in your request: home_id or reference_property_id
- [Retrieve task](https://developer.breezeway.io/reference/retrieve-task.md)
- [Create task](https://developer.breezeway.io/reference/create-task.md)
- [Update task](https://developer.breezeway.io/reference/update-task.md)
- [Close task](https://developer.breezeway.io/reference/close-task.md)
- [Delete task](https://developer.breezeway.io/reference/delete-task.md)
- [Approve task](https://developer.breezeway.io/reference/approve-task.md): Action to move task to 'Approved' status. Task can only be moved to "approved" status if it was previously "closed"
- [Reopen Task](https://developer.breezeway.io/reference/reopen-task.md): Action of reopening a task after it has been closed. This will put task in-progress
- [Retrieve task comments](https://developer.breezeway.io/reference/retrieve-task-comments.md)
- [Add task comment](https://developer.breezeway.io/reference/add-task-comment.md)
- [Retrieve task requirements](https://developer.breezeway.io/reference/retrieve-task-requirements.md): Retrieve user responses to completed tasks
- [List available task tags](https://developer.breezeway.io/reference/list-available-task-tags.md): Provides a list of available task tags for the specified company. Creation of task tags can only be performed in the application.
- [Get tags for task](https://developer.breezeway.io/reference/get-tags-for-task.md)
- [Add tags for task](https://developer.breezeway.io/reference/add-tags-for-task.md)
- [Delete tags for task](https://developer.breezeway.io/reference/delete-tags-for-task.md)
- [Add Task Photo](https://developer.breezeway.io/reference/add-task-photo.md)
- [List people](https://developer.breezeway.io/reference/list-people.md)
- [Retrieve person](https://developer.breezeway.io/reference/retrieve-person.md)
- [Resend invitation](https://developer.breezeway.io/reference/resend-invitation.md)
- [List companies](https://developer.breezeway.io/reference/list-companies.md): Describe companies accessible with provided authorization token. Used for cross-company accounts only. This will return only active companies with paid status. Trial and test accounts will not show in results.
- [List available templates](https://developer.breezeway.io/reference/list-available-templates.md): List of active templates (checklists) for a Breezeway company. Templates can be used to Create tasks.
- [List subdepartments](https://developer.breezeway.io/reference/list-subdepartment.md): Provides a list of subdepartments for the specified company. Creation of subdepartments can only be performed in the application.
- [List available supplies](https://developer.breezeway.io/reference/list-available-supplies.md): Provides a list of Supplies for the specified company. Creation of Supplies can only be performed in the application.
- [List subscriptions](https://developer.breezeway.io/reference/list-subscriptions.md): Retrieve active webhook subscriptions for a company
- [Create subscription](https://developer.breezeway.io/reference/create-subscription.md): URL validation enforced. URLs must be valid and able to return a success status code.
- [Delete subscription](https://developer.breezeway.io/reference/delete-subscription.md)

## Changelog
- [Adding bill_to to supplies and costs](https://developer.breezeway.io/changelog/adding-bill_to-to-supplies-and-costs.md)
- [Create task: Assign default workers](https://developer.breezeway.io/changelog/assign-default-workers-when-creating-a-task.md)
- [Subdepartment List Endpoint](https://developer.breezeway.io/changelog/subdepartment-list-endpoint.md)
- [Task API Updates](https://developer.breezeway.io/changelog/task-api-updates.md)
- [Add Property Contact API](https://developer.breezeway.io/changelog/add-property-contact-api.md)