API Reference
Start typing to search…

Prospect Jobs

Prospect Job Management and Sales Pipeline

Endpoints for managing prospect jobs in the RoofLink sales pipeline. Prospects represent unapproved jobs in the sales pipeline that are being evaluated before conversion to active jobs.

What are Prospect Jobs?

Prospect Jobs are a specific job type in the RoofLink system representing potential roofing projects in the sales pipeline. These are jobs that have not yet been approved. Prospects are used to track leads through the sales process from initial contact to project approval.

Key Characteristics

  • Prospects are unapproved jobs in the sales pipeline
  • They track potential projects before they become active jobs
  • They include customer details, location data, and sales assignments
  • They have a dedicated checklist workflow for tracking sales progress
  • They can be filtered by various pipeline statuses (unverified, verified, inspected, signed, etc.)

Supported Prospect Job Operations

This category includes the following operations:

Querying Prospect Jobs

  • List Prospect Jobs: Retrieve a paginated list of prospect jobs with extensive filtering options by employee assignments, dates, status, geographic location, and more. By default returns both active and deleted prospects; use date_deleted__isnull=true to exclude deleted prospects.
  • Retrieve Prospect Job Details: Get detailed information about a specific prospect job including customer details, employee assignments, pipeline status, geographic coordinates, photos, and timestamps.
  • Get Prospect Job Statistics: Retrieve count statistics for different prospect filter categories, showing the number of prospects matching predefined filters (unverified, verified, inspected, signed, etc.) and any custom filters created by users.

Prospect Job Workflow

  • Get Prospect Job Checklist Status: Retrieve the checklist status for a specific prospect including verification steps like lead verification, adjuster meeting scheduling, job submission, and deletion status. Provides detailed information about each checklist item including completion status, dates, permissions, and associated metadata.

Creating Prospect Jobs

Since Prospect Jobs are a job type, they are created using the general job creation endpoints available in the Jobs tag.

How to Create Prospect Jobs

To create a new prospect job, use the job creation endpoint:

  • Create Address-Only Lead: This endpoint creates a prospect job with address and location data, along with an associated customer record. The created job enters the sales pipeline as a prospect.

When you create a job using this endpoint, the system automatically:

  • Creates a new customer record
  • Creates a new prospect job linked to the customer
  • Initializes the prospect checklist workflow
  • Assigns the job to the sales pipeline

Important Note About Job Types

Prospect jobs share the same underlying data model as other job types in RoofLink. This means that all general job operations in the Jobs tag are also applicable to prospect jobs, including:

  • Updating job information
  • Managing job assignments
  • Adding notes and communications
  • Uploading photos and documents
  • Managing customer contact information

When working with prospect jobs, you can use any job-related endpoint by referencing the prospect's job ID. The system handles the job type internally while providing consistent access through the API.

Prospect Sales Pipeline

Pipeline Stages

Prospects progress through several stages in the sales pipeline:

  1. Unverified: Initial leads that need verification
  2. Verified: Leads that have been confirmed and qualified
  3. Inspected: Properties that have been physically inspected
  4. Signed: Prospects where contracts or agreements have been signed
  5. Submitted: Prospects that have been submitted for approval or processing

Tracking Progress

Use the following endpoints to monitor prospect progress:

Filtering and Search

The List Prospect Jobs endpoint provides extensive filtering capabilities:

Employee Filters

  • Employee Assignments: Filter by primary rep, secondary rep, project manager, or any assigned employee
  • Regional Filters: Find prospects assigned to specific regions or representatives

Status Filters

  • Pipeline Status: Filter by verification, inspection, signing, or submission status
  • Deletion Status: Include or exclude deleted prospects using date_deleted__isnull=true

Date Filters

  • Creation Date: Filter by when the prospect was created
  • Modification Date: Filter by recent updates
  • Custom Date Ranges: Use date range parameters for time-based queries

Geographic Filters

  • Location Coordinates: Filter prospects by latitude/longitude
  • Address Components: Filter by city, state, or postal code
  • Regional Boundaries: Find prospects within specific geographic areas

Pagination

Prospect job lists are paginated with:

  • Default page size: 10 items
  • Maximum page size: 100 items
  • Results include pagination metadata: count, from_index, to_index, next, previous, and next_page. See the responses page for details.
  • Prospects are returned in reverse chronological order by creation date