Skip to main content
GET
List works

Authorizations

Authorization
string
header
required

An API key created in BeanRails, for example brk_live_....

Query Parameters

limit
integer
default:10

Records per page. Defaults to 10, capped at 100.

Required range: 1 <= x <= 100
page
integer
default:1

Page number, starting at 1.

Required range: x >= 1

Free-text search across the record's main fields, such as its number, name or email.

status
enum<string>

Filter by work status.

Available options:
new,
vehicle_assigned,
in_progress,
failed,
cancelled,
completed
contact_id
integer

Filter by contact ID.

vehicle_id
integer

Filter by assigned vehicle ID.

zone_id
integer

Filter by zone ID.

from
string<date>

Works on or after this date (YYYY-MM-DD, workspace timezone).

to
string<date>

Works on or before this date (YYYY-MM-DD, workspace timezone).

Response

A page of works.

data
object[]
meta
object