Skip to main content
GET
Get Work Order List

Authorizations

Authorization
string
header
required

Query Parameters

from_date
string<date>
required

Start date filter (inclusive). Format: YYYY-MM-DD.

Example:

"2025-01-01"

to_date
string<date>
required

End date filter (inclusive). Format: YYYY-MM-DD. Must be after from_date.

Example:

"2025-01-31"

page
integer

Page number for paginated results.

Example:

1

page_size
integer

Number of results per page (max 25, default 10).

Required range: x <= 25
Example:

10

ordering
string

ORM field path to order by. Prefix with - for descending.

Example:

"-created_datetime"

filter
string

JSON-encoded array of filter objects. Each object has column, value, and contains (operator). Supported operators: is, is_not, is_in, is_not_in, contains, before, after, greater_than, less_than, between, between_datetime, isnull, today, exclude, exclude_in.

Example:

"[{\"column\":\"status\",\"value\":\"Pending\",\"contains\":\"is\"}]"

Response

List of work orders retrieved successfully

count
integer

Total number of work orders

Example:

50

next
string | null

URL to the next page of results

Example:

"/work-orders/?page=2"

previous
string | null

URL to the previous page of results

Example:

null

results
object[]