API ReferenceJobs

List Jobs

Returns a paginated list of jobs for the authenticated business. Defaults to sorting by scheduledAt descending. Supports filtering by text, assigned technicians, scheduled date range, and total cost range.

Requires scope: jobs:read

Authentication

API_KEYstring
API Key authentication via header

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

sortstringOptional

Sort by field,direction (Spring Pageable format; direction asc or desc, default asc). Allowed fields: id, name, number, scheduledAt, note, active, createdAt, updatedAt. Default order (when no sort is supplied): scheduledAt,desc.

textToSearchstringOptional

Case-insensitive substring match against the job name.

activebooleanOptional

Filter by active status. Defaults to true (archived jobs excluded). Set to false to return only archived jobs.

techIdslist of UUIDsOptional
Filter to jobs assigned to any of the provided user IDs.
scheduledFromdateOptional

Inclusive lower bound (ISO yyyy-MM-dd) for scheduledAt.

scheduledTodateOptional

Inclusive upper bound (ISO yyyy-MM-dd) for scheduledAt.

totalCostFromdoubleOptional

Inclusive lower bound for the job’s total cost. Must be >= 0.

totalCostTodoubleOptional

Inclusive upper bound for the job’s total cost. Must be >= 0.

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error