List tasks

get

https://api.breezeway.io/public/inventory/v1/task/

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

home_id

int32

required

Property ID from Breezeway system. One of either home_id or reference_property_id is required.

reference_property_id

string

required

Property ID from external system. One of either home_id or reference_property_id is required.

reference_company_id

string

Company ID from external system; required if using cross-company access

type_department

string

enum

Allowed:

scheduled_date

string

Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31

created_at

string

Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31

finished_at

string

Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31

updated_at

string

Date range (YYYY-MM-DD) separated by comma, e.g. 2020-01-01,2020-03-31

assignee_ids

array of int32s

Assignee IDs separated by commas, e.g. 7172,47634

assignee_ids

limit

int32

Defaults to 100

Number of records returned per page

page

int32

Defaults to 1

The page to return

sort_by

string

Defaults to created_at

Field to sort results by

sort_order

string

Defaults to desc

Order to sort results in ('asc' or 'desc')

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200