# Get prospects

Retrieve prospects with optional filtering and pagination

Endpoint: GET /prospects
Version: 1.1.1
Security: BearerAuth

## Query parameters:

  - `id` (number)
    Filter by prospect ID
    Example: 123

  - `account_id` (string)
    Filter by prospects associated with a specific RentEngine account by the account's id
    Example: "4b88ff32-8ba0-4bbf-8e60-c789909ac176"

  - `units_of_interest` (array)
    Filter by prospects interested in specific units (comma-separated list of unit IDs)
    Example: [234]

  - `status` (string)
    Filter prospects by status
    Example: "Showing Scheduled"

  - `source` (string)
    Filter prospects by source
    Example: "Zillow"

  - `created_after` (string)
    Filter prospects created after this timestamp (ISO 8601 format)
    Example: "2023-01-15T12:00:00Z"

  - `created_before` (string)
    Filter prospects created before this timestamp (ISO 8601 format)
    Example: "2023-01-17T12:00:00Z"

  - `limit` (integer)
    Maximum number of items to return per page (default 50, max 100)
    Example: 25

  - `page_number` (integer)
    Page number for pagination (0-indexed, default 0)
    Example: 1

## Response 200 fields (application/json):

  - `id` (number)
    Unique identifier for the prospect
    Example: 123

  - `name` (string,null)
    Prospect's name
    Example: "John Doe"

  - `email` (string,null)
    Prospect's email address
    Example: "john@example.com"

  - `phone` (string,null)
    Prospect's phone number
    Example: "+15551234567"

  - `status` (string)
    Current status of the prospect
    Example: "Showing Scheduled"

  - `source` (string,null)
    Where the prospect came from
    Example: "Zillow"

  - `unit_of_interest` (number)
    ID of the unit the prospect is interested in
    Example: 123

  - `notes` (string,null)
    Notes about the prospect
    Example: "Interested in 2BR units"

  - `prescreened` (boolean,null)
    Whether the prospect has been prescreened
    Example: true

  - `voucher_holder` (boolean,null)
    Whether the prospect holds a housing voucher

  - `normalized_phone_number_generated` (string,null)
    Normalized phone number if normalizable. Else null.
    Example: "+15551234567"

  - `license_number` (string,null)
    License number if applicable
    Example: "ABC123"

  - `prospect_type` (string)
    Type of prospect
    Enum: "Self", "Agent"

  - `created_at` (string)
    When the prospect was created
    Example: "2023-01-15T12:00:00Z"

  - `updated_at` (string)
    When the prospect was last updated
    Example: "2023-01-16T14:30:00Z"

## Response 400 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (array)
    Detailed error information
    Example: [{"keyword":"required","dataPath":"","schemaPath":"#/required","params":{"missingProperty":"account_id"},"message":"should have required property 'account_id'"}]

## Response 401 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (array)
    Detailed error information
    Example: [{"keyword":"required","dataPath":"","schemaPath":"#/required","params":{"missingProperty":"account_id"},"message":"should have required property 'account_id'"}]

## Response 500 fields (application/json):

  - `error` (string, required)
    Error message
    Example: "Invalid request parameters"

  - `details` (array)
    Detailed error information
    Example: [{"keyword":"required","dataPath":"","schemaPath":"#/required","params":{"missingProperty":"account_id"},"message":"should have required property 'account_id'"}]