Skip to main content
GET
Page jobs with complete saved sold and earned credits

Authorizations

Authorization
string
header
required

Existing Breezy API key. Grants all published reads in its associated company. No app permission scopes.

Query Parameters

ids
string<uuid>[] | null

Repeat ids for a bounded ID set. Valid foreign or missing IDs contribute no list rows.

Required array length: 1 - 100 elements
limit
integer
default:50

Maximum parent records or report rows. Complete children are always included.

Required range: 1 <= x <= 100
cursor
string | null

Repeat the original filters; any valid page size may continue. Foreign-company, tampered or mismatched cursors return INVALID_CURSOR.

Minimum string length: 1
created_from
string<date-time> | null

Inclusive creation instant.

created_before
string<date-time> | null

Exclusive creation instant.

account_id
string<uuid> | null
business_unit_id
string<uuid> | null
job_type_id
string<uuid> | null
job_class
enum<string> | null
Available options:
SERVICE,
MAINTENANCE,
ESTIMATE_REPAIR,
ESTIMATE_REPLACE,
INSTALL,
WARRANTY,
CALLBACK,
SALES,
UNKNOWN,
null
team_member_id
string<uuid> | null

A currently validated credited company member.

credit_type
enum<string> | null
Available options:
SOLD,
EARNED,
null
location_id
string<uuid> | null
report_from
string<date> | null

Inclusive company-local work-completion date.

report_before
string<date> | null

Exclusive company-local work-completion date.

Response

Successful read. Clients ignore unrecognized response fields.

data
object[]
required
pagination
object
required
meta
object
required

Generation time and company timezone. generated_at is not a snapshot or synchronization token.