List prospect jobs

get

https://integrate.rooflink.com/roof_link_endpoints/api/light/jobs/prospect/

Retrieves a paginated list of prospect jobs (unapproved jobs in the sales pipeline). This endpoint supports extensive filtering options to query prospects by employee assignments, dates, status, geographic location, and more.

Important: By default, this endpoint returns both active and deleted prospects for administrative visibility. To exclude deleted prospects, use the filter parameter date_deleted__isnull=true. The results include both verified and unverified leads.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number for pagination

page_size

integer

1 to 10

Defaults to 10

Number of items per page

string

Search across customer name, email, phone, cell, and job address fields

ids

array of integers

Filter by specific job IDs

ids

rep

integer

Filter by primary sales representative (employee ID)

alt_rep

integer

Filter by alternate sales representative (employee ID)

rep_or_alt_rep

integer

Filter by either primary or alternate sales representative (employee ID)

marketing_rep

integer

Filter by marketing representative (employee ID)

project_manager

integer

Filter by project manager (employee ID)

pre_insurance_reviewer

integer

Filter by pre-insurance reviewer (employee ID)

post_insurance_reviewer

integer

Filter by post-insurance reviewer (employee ID)

assigned_to_job

integer

Filter by any employee assigned to the job including primary sales representative, alternate sales representative, marketing representative, or project manager (employee ID)

team

integer

Filter by team (matches if primary sales representative or marketing representative is in the specified team)

lead_status

integer

Filter by company lead status

management_company

integer

Filter by management company

insurance_company

integer

Filter by insurance company (matches prospects with claims associated with the specified insurance company)

customer__source

integer

Filter by lead source

customer__region

integer

Filter by customer region

job_type

string

enum

Filter by job type.

Value	Description
`c`	Commercial
`r`	Residential
`d`	Designer
`m`	MRP

Allowed:

bid_type

string

enum

Filter by bid type.

Value	Description
`c`	Cash Bid
`i`	Insurance Bid
`r`	Repair
`f`	Finance

Allowed:

zipcode

string

Filter by ZIP code

status

string

enum

Filter by prospect status.

Value	Description
`ad`	Address
`uv`	Unverified Lead
`ua`	Unassigned Lead
`as`	Assigned Lead
`v`	Verified Lead
`i`	Inspected
`cf`	Claim Filed
`rla`	Measured
`est`	Estimate Created
`si`	Signed
`su`	Submitted
`re`	Rejected
`d`	Deleted

claim_status

string

Filter by claim status (free-text field, varies by company configuration)

no_recent_activity

boolean

Filter prospects with no activity in the last 15 days

top_prospect

boolean

Filter prospects whose customers have been manually marked as top prospects by sales representatives or other employees.

When set to true, returns only prospects associated with customers that employees have added to their "top 10" list.

waiting_on_signatures

boolean

Filter prospects waiting for document signatures

date_created__gte

date-time

Filter prospects created on or after the specified date and time (ISO 8601 format)

date_created__lte

date-time

Filter prospects created on or before the specified date and time (ISO 8601 format)

date_created__within

string

enum

Filter prospects created within the specified time period

Allowed:

date_last_edited__gte

date-time

Filter prospects last edited on or after the specified date and time (ISO 8601 format)

date_last_edited__lte

date-time

Filter prospects last edited on or before the specified date and time (ISO 8601 format)

date_assigned__isnull

boolean

Filter prospects where the assignment date is null or not null

date_assigned__gte

date-time

Filter prospects assigned on or after the specified date and time (ISO 8601 format)

date_assigned__lte

date-time

Filter prospects assigned on or before the specified date and time (ISO 8601 format)

date_verified__isnull

boolean

Filter prospects where the verification date is null (unverified) or not null (verified)

date_verified__gte

date-time

Filter prospects verified on or after the specified date and time (ISO 8601 format)

date_verified__lte

date-time

Filter prospects verified on or before the specified date and time (ISO 8601 format)

date_verified__within

string

enum

Filter prospects verified within the specified time period

Allowed:

date_claim_filed__isnull

boolean

Filter prospects where the claim filing date is null or not null

date_claim_filed__gte

date-time

Filter prospects with claims filed on or after the specified date and time (ISO 8601 format)

date_claim_filed__lte

date-time

Filter prospects with claims filed on or before the specified date and time (ISO 8601 format)

date_inspection_scheduled__isnull

boolean

Filter prospects where the inspection scheduling date is null or not null

date_inspection_scheduled__gte

date-time

Filter prospects with inspections scheduled on or after the specified date and time (ISO 8601 format)

date_inspection_scheduled__lte

date-time

Filter prospects with inspections scheduled on or before the specified date and time (ISO 8601 format)

date_inspection_completed__isnull

boolean

Filter prospects where the inspection completion date is null or not null

date_inspection_completed__gte

date-time

Filter prospects with inspections completed on or after the specified date and time (ISO 8601 format)

date_inspection_completed__lte

date-time

Filter prospects with inspections completed on or before the specified date and time (ISO 8601 format)

date_signed__isnull

boolean

Filter prospects where the contract signing date is null or not null

date_signed__gte

date-time

Filter prospects with contracts signed on or after the specified date and time (ISO 8601 format)

date_signed__lte

date-time

Filter prospects with contracts signed on or before the specified date and time (ISO 8601 format)

date_submitted__isnull

boolean

Filter prospects where the submission date is null or not null

date_submitted__gte

date-time

Filter prospects submitted on or after the specified date and time (ISO 8601 format)

date_submitted__lte

date-time

Filter prospects submitted on or before the specified date and time (ISO 8601 format)

date_deleted__isnull

boolean

Filter prospects where the deletion date is null (active prospects) or not null (deleted prospects)

date_deleted__gte

date-time

Filter prospects deleted on or after the specified date and time (ISO 8601 format)

date_deleted__lte

date-time

Filter prospects deleted on or before the specified date and time (ISO 8601 format)

date_pre_contract_signed__isnull

boolean

Filter prospects where the pre-contract signing date is null or not null

date_pre_contract_signed__gte

date-time

Filter prospects with pre-contracts signed on or after the specified date and time (ISO 8601 format)

date_pre_contract_signed__lte

date-time

Filter prospects with pre-contracts signed on or before the specified date and time (ISO 8601 format)

date_rejected__isnull

boolean

Filter prospects where the rejection date is null or not null

date_rejected__gte

date-time

Filter prospects rejected on or after the specified date and time (ISO 8601 format)

date_rejected__lte

date-time

Filter prospects rejected on or before the specified date and time (ISO 8601 format)

estimate__date_last_edited__isnull

boolean

Filter prospects where the estimate last edit date is null or not null

estimate__date_last_edited__gte

date-time

Filter prospects with estimates last edited on or after the specified date and time (ISO 8601 format)

estimate__date_last_edited__lte

date-time

Filter prospects with estimates last edited on or before the specified date and time (ISO 8601 format)

bounds

string

Filter by geographic bounding box. Provide comma-separated coordinates in the format: ne_lat,ne_lng,sw_lat,sw_lng

Responses

200Successful response with paginated list of prospect jobs

400Bad Request - Invalid query parameters or filter values

401Unauthorized - Authentication credentials were not provided or are invalid

403Forbidden - User does not have the required permissions to access prospect jobs

429Too Many Requests - Rate limit exceeded for this endpoint

503Service Unavailable - Public API rate limits exceeded