Breezeway API

13 endpoints for Breezeway, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/breezeway
Connects with: Your own Breezeway account (administrator or supervisor to create, assign and approve tasks)
Integration page: Breezeway

Read (7)

Return data and change nothing in the account.

Breezeway Endpoints: Read
Endpoint	Description
GET /properties	the properties in your Breezeway account, with ID, name and address.
GET /peoples	Lists the staff of your account with their departments and weekly shifts.
GET /templates	Lists the active task templates (checklists) of a department.
GET /tasks	Lists tasks filtered by property, department, dates and assignee.
GET /tasks/{task_id}	Returns one task with assignees, tags, supplies and report link.
GET /task-comments	Lists the comments on a task, oldest first.
GET /tasks/{task_id}/checklist	Returns the checklist answers staff gave on a completed task.

Change the account. Calls marked Confirm wait for the user to approve them.

Breezeway Endpoints: Write
Endpoint	Description
POST /properties/{property_id}/tasks Confirm	Creates a task on a property.
POST /tasks/{task_id}/assign Confirm	Sets the people assigned to a task.
POST /tasks/{task_id}/comment Confirm	Adds a comment to a task, under your name.
POST /tasks/{task_id}/close Confirm	Marks a task as finished.
POST /tasks/{task_id}/approve Confirm	Moves a closed task to Approved.
POST /tasks/{task_id}/reopen Confirm	Puts a closed task back in progress.